Developer CD Series 2000 April: Mac OS SDK/Dev.CD Apr 00 SDK1.toast/Development Kits/Mac OS/Apple Remote Access API/Documentation/Add-on Security API/Add-on Security API

Text File | 1994-09-15 | 231.9 KB | 384 lines | [ONLN/HLX2]

Apple Remote AccessAdd-on Security InterfaceAuthor:  Farzad SarabiVersion 1.0November 4, 1993Copyright © 1992, 1993 Apple Computer, Inc.Table of ContentsIntroduction    1Overview    2Security Module Structure    5Module Information Resource ('sinf' ID 200)    6Code Resource Structure    8User Configuration (UCNF Resource ID 200)    11Client-side Protocol (CLPR Resource ID 200)    12Server-side Protocol (SRPR Resource ID 200)    13Connection Configuration (CCNF Resource ID 200)    14Client Side Line-level (CLLN Resource ID 200)    15Actions    16kSecurityStartup    16kSecurityShutdown    16kSecurityBegin    16kSecurityEnd    16kSecurityDataAvailable    16kSecurityAbort    16kSecurityTickleAction    17ARA Service Routines    18ARARead    19ARAWrite    21ARALogMessage    22ARACallBackAt    23ARAAllowUser    24ARADontAllowUser    25ARAReadSecurityData    26ARAReadLockSecurityData    27ARAWriteSecurityData    28ARAUnlockSecurityData    29ARAGetUserInfo    30ARATickleMe    31ARACompleteOperation    32Appendix A:  Security Interface Header File    33Appendix B:  Security Module Shell    41Appendix C:  Miscellaneous    48Runtime Environment    48Building  an Add-on Security Module    48ARA Security Interface Disk    49IntroductionThis document describes the add-on security interface used in Apple Remote Access (ARA).  This document is written for a security module writer, and explains the ARA interface as seen from an add-on security module.Add-on security modules (security modules) contain code resources that allow additional methods of authenticating users.  ARA uses passwords and a call-back mechanism as its default security.  If you have a system for identifying a user, you can develop a security module to integrate your authentication methods into ARA.We have defined two types of security devices.  Devices that sit in front of or behind a modem and physically prevent a connection prior to user authentication are called line-level security devices.  Systems that perform their authentication after the ARA server and its client have established a connection are classified as protocol-level security devices.  You can develop security modules for each type of device.The next section gives a brief overview of add-on security modules.The Security Module Structure section describes a module and its structure in more detail.The Code Resources section describes the different kinds of code resources that can exist in a security module.The Actions section describes the actions ARA sends to code resources to request services.The ARA Service Routines section describes the services that ARA provides to security modules.Appendix A is the header file for gaining access to ARA Service Routines.Appendix B is an empty shell for building a code resource.Appendix C contains miscellaneous information about security module's such as a modules runtime environment, how you can build a module, and the enclosed developer disk contents.OverviewA security module is a Macintosh file type 'CLMP'.  The creator is vendor specific.  You can request a creator for your security module from Apple Developer Technical Support (DTS).Internally a security module contains a number of special resources.  Every module must contain an information resource that describes your modules capabilities.  Additionally your module may contain a number of code resources.  These code resources are executed to perform various functions (e.g. authentication, configuration) for your security module.  ARA then can use your module to authenticate a user's identity beyond the password mechanism that it contains.  ARA security modules that are placed in the Extensions folder.The following diagram illustrates the contents of a security module:The information resource is described in the module Information Resource section.Each of the code resources provides an entry point.  This is a routine which will be called when ARA needs to execute a code resource.  The entry point routine and the operations it must support are described in the Code Resource Structure section.When a code resource is loaded, it will be able to access ARA to request certain services.  For example it can have data sent to the remote machine.  These services are provided as routines that can be called from a security module.  They are described in the ARA Service Routines section.The following diagram is a high level view of a loaded code resource:Security Module StructureA security module is built by creating a Macintosh file that has a 'CLMP' type.  This is used by ARA to identify the file as a security module.  The module has to be placed in the Extensions folder for ARA to find it.  You can do this by dragging it on top of your system folder after installing ARA.  The module's creator is defined by you.  You must request a creator from Developer Technical Support (DTS).Additionally the file must contain at least a 'sinf' resource, and a number of code resources for performing various operations.  The 'sinf' resource and the code resources are described below.Currently there are five types of code resources that ARA supports.  They are described in sub-sections below. Code resources must have the appropriate type, and their resource ID should be 200.Module Information Resource ('sinf' ID 200)Your module must have a 'sinf' resource with a resource ID of 200.  The 'sinf' resource describes what the module's capabilities are.In your resource definition file, you should create a 'sinf' resource, and fill in the appropriate fields.  The template for the resource is defined in a file named "SecurityTypes.r".  This file is found on the developer disk.  The following is the template for a 'sinf' resource:type 'sinf'    {                    /* security information resource */        unsigned    longint;        /* fflags contains info about module */        literal        longint;        /* fsignature identifies module */        unsigned    longint;        /* fversion */        unsigned     longint;        /* fmin_version */        unsigned    longint;        /* fmax_version */        unsigned    longint;        /* fserver_data */        unsigned    longint;        /* fclient_data */        pstring[ 31 ];                /* module name */};The first longint is a set of flags that define what the capabilities of the module are.  The values for the flags are defined in "SecurityResInfo.h", found on the developer disk.  The values should be a combination of the following using the "OR" operator:kSecurityHasLineLevel    Use this flag if your module is to be used for line-level authentication of a user.  This flag causes the module to be displayed on the client side.  It let's the user select this module for a connection document, used to connect to a port with a physical security device.    kSecurityHasProtocolLevel    This flag indicates the module provides protocol level authentication.  It can be used in combination with the kSecurityHasServerSide and kSecurityHasClientSide flags to indicate if the module supports the client side, server side, or both.    kSecurityHasServerSide    This flag is set for a module that provides the code resources needed for the server side.  Any module that has code to be executed on the server should set this flag, including user configuration.    kSecurityHasClientSide    This flag is set for a module that provides code resources needed for the client side.  Any module that has code to be executed on the client should set this flag.    kSecurityHasUserConfig    This flag is used for a protocol-level module that has a code resource for configuring users on the server.  Has 'UCNF' resource.    kSecurityHasConnectionConfig    This flag is used for a line-level module that has a code resource for security configuration on the client side.  Has a 'CCNF' resource.    kSecurityHasUserDialog    Don't use this flag.    kSecurityHasConnectionDialog     Don't use this flag.    The second longint is the signature of the module.  This value uniquely identifies your security module.  You should reserve a value through Apple Developer Technical Support (DTS).  This value should be the same as your file's creator, but it can be different.  When they are different, ARA uses the value defined in the 'sinf' resource.  For protocol-level modules this signature is used to associate a client module with the server module.The next three longints are version numbers and are only used for protocol level modules.  The first field is "fversion" and defines the module's version.  The field after "fversion" are "fmin_version", and "fmax_version".  For protocol-level authentication, they are used for checking the client module's compatibility with the server's.  The client's "fversion" must be a number between the server module's "fmin_version" and "fmax_version". The next two longints, "fserver_data" and "fclient_data", are not used, and should be set to zero.The last field is a Pascal string that is your module's name.  This name is used in dialog boxes and anywhere your modul'es name is displayed.Code Resource StructureThe following sub-sections describe the structure of code resources.MySecurityProcEntryEvery code resource must provide a routine named "MySecurityProcEntry".  This is the entry point to the code resource.  ARA calls it through the Security Interface.  It should be defined as follows:pascal long        MySecurityProcEntry( SecurityActions        Action,                                     SecurityReference        MyReference,                                     long                    LongParam )ARA sends actions to your code resources to request it to perform a service.  You should process the actions and return control to ARA as quickly as possible.  Actions are defined in the file SecurityPublic.h.  The "Actions" section describes actions in detail.  The following is a list of the actions:kSecurityStartupkSecurityShutdownkSecurityBeginkSecurityEndkSecurityDataAvailable,kSecurityAbortkSecurityTickleActionMyReference is a unique value that defines an instance of the code resource.  It is used when you call any of the ARA Service Routines.  It uniquely identifies your thread.LongParam is used to pass additional information for an action.  Currently it is only used with kSecurityTickleAction.Your entry routine should process the action as soon as possible.  It should not stay go into any loops.  It can post asynchronous calls to ARA and other Toolbox routines, but it should return control back to ARA quickly.  YOU MUST RETURN CONTROL BACK TO ARA AS SOON AS POSSIBLE.Your routine's return value is a result code ARA examines for possible errors in "MySecurityProcEntry".  The possible result codes are "SecurityErrors" defined in "SecurityPublic.h".  Return "kSecurityNoErr" if  your routine is successful.SecurityInterface.o"SecurityInterface.o" is the glue file that provides the ARA Service Routines.  It must be linked with each code resource.  When linking a code resource, you must have "SecurityInterface.o" as the first file in the linker's object file list.  The MPW linker does not shuffle code.  The entry point to "SecurityInterface.o" must become the entry point to your code resource.MPW linker uses the -m option to perform code-flow analysis and remove any dead code.  To keep your executable code from being stripped, you must provide the following option in the linker command line:-m SECURITYINTERFACEENTRYPROCCompletion RoutineMost of the ARA Service Routines are asynchronous.  After an asynch ARA routine finishes, it informs you code resource by calling a completion routine.  Your completion routine should have the following declaration:pascal void        MyCompletionProc( SecurityReference        MyReference,                                  int                    ResultCode,                                  void                    * DataPtr,                                  int                    DataSize,                                  long                    CompletionParam )You pass a pointer to your completion routine as one of the parameters to asynchronous ARA Service Routines.MyReference should is the same value passed to "MySecurityProcEntry".  It identifies your instance.ResultCode is the result of the asynchronous ARA Service you had requested.  It will be non zero if the operation failed.  It will contain one of the values in ARAErr defined in SecurityPublic.h.  You should check its value at the start of your completion routine before you do any other processing.  If a read or write times out, the ResultCode will be ARATimeout.DataPtr is the pointer you passed to the asynch ARA Service Routine.  E.g. this will point to the data read by ARARead.DataSize will be the actual size of processed data.  E.g. the number of bytes read by ARARead.CompletionParam is an additional long you provide.  Its value will be the same value you passed to the asynch ARA Service Routine.  You can use it as a state indicator.  E.g. you can define an enumeration containing the set of all your states.  When you call an asynch ARA routine, pass the state you want to be in when the call is done.  E.g. pass "kFinished1stRead" to ARARead.  When your completion routine gets called with CompletionParam equal to "kFinished1stRead", the ARARead has finished and you can go to the next state.  See the sample module on the developer disk for an example of this.You should not call any Memory Manager routines, or any routines that result in a Memory Manager call from a completion routine.  If you need to call these types of routines, call ARATickleMe and handle it in the kSecurityTickleAction.Runtime Environment (A5 World)An A5 World is setup for your code resource by ARA.  You don't need to be concerned with initializing or setting up the A5 world in the code resource.  ARA sets up the A5 world prior to executing any of the code resource (entry routine, and completion routines).  Since the code resource has an A5 world, it you can have static (global) data and use the data the same way as an application.During the execution of your code resource, the resource fork of the security module is open, and it is put on top of the resource forks stack.  The file is opened in read only mode, so you should not attempt to write any data to the module's resource fork.  A better way of storing data is to store it in a separate preference file, which will not be deleted when you update a user's security module.You can make calls to Mac Toolbox routines.  Whenever possible you should call asynchronous routines, so you can return control to ARA.  Furthermore, you should not go into any loops or call SystemTask as a way of returning control to ARA.ARA Service RoutinesARA provides a number of services accessible through ARA Service Routines.  The header file "SecurityInterface.h" has the declarations for these routines.   To use them you must link with "SecurityInterface.o".The ARA Service Routines are described in detail in a later section.User Configuration (UCNF Resource ID 200)This code resource is executed when a user window is open on the ARA server admin, and the security module's configuration button is selected.  It is used for configuring protocol-level security information on a per-user basis.  The code resource should display a modal dialog box and get any needed information.  It can store 150 bytes of data for each user (see ARAWriteSecurityData, and ARAReadSecurityData).On kSecurityBegin you should start your processing, e.g. request to read the existing security data (ARAReadLockSecurityData), or to get the user's name (ARAGetUserInfo).  When you've obtained this information, you can call ARATickleMe to put up the modal dialog box (it must be a modal dialog box).  You must display the user's name at the top of this dialog box.  The user can then input/modify the information and either save or cancel.  If the user selects to save the data, you must write it out by calling ARAWriteSecurityData.  This information will then be available to the server-side protocol-level authentication module.The following ARA Service Routines can be used by a UCNF code resource:ARALogMessageARAReadSecurityDataARAReadLockSecurityDataARAUnlockSecurityDataARAWriteSecurityDataARAGetUserInfoARATickleMeARACompleteOperationClient-side Protocol (CLPR Resource ID 200)This code resource is executed on the ARA client for protocol-level authentication.  The corresponding server-side protocol-level module is also executed on the server, and the two module's can communicate with each other.The client module's state should be driven by the server, and when the authentication has been completed, both sides should call ARAAllowUser/ARADontAllowUser, so ARA can progress to the next state.A CLPR module can pass a maximum of 500 bytes of data to ARAWrite/ARARead.  The ARAWrite and ARARead will communicate with the server-side protocol (i.e. ARARead on the client side will read data written by the server module).On kSecurityBegin you should start your state machine, getting information from the user and sending it to the server module.  The server module should inform the client module when the user is authenticated or rejected, at which time it should call ARAAllowUser, or ARADontAllowUser.The following ARA Service Routines can be used by a CLPR code resource:ARAReadARAWriteARALogMessageARAAllowUserARADontAllowUserARATickleMeARACompleteOperationServer-side Protocol (SRPR Resource ID 200)This code resource is executed on the server to authenticate a user after the ARA protocol has been established.  It can communicated with the corresponding client authentication module.  ARA loads the client module automatically.This code resource should get the user information from the client module and determine if the user should be allowed in.  Once a user has been authenticated or rejected, this code resource should inform the client side, and then call ARAAllowUser/ARADontAllowUser.  The client code resource should also call ARAAllowUser/ARADontAllowUser.A SRPR code resource can write and read a maximum of 500 bytes of data using ARAWrite or ARARead.  The data is exchanged with client module.This code resource can use ARAReadLockSecurityData, ARAReadSecurityData, ARAWriteSecurityData, and ARAUnlockSecurityData to access and modify the 150 bytes of security data associated with each user.  Each security module can have 150 bytes of data for each user.The following ARA Service Routines can be used by a SRPR code resource:ARAReadARAWriteARALogMessageARACallBackAtARAAllowUserARADontAllowUserARAReadSecurityDataARAReadLockSecurityDataARAUnlockSecurityDataARAWriteSecurityDataARAGetUserInfoARAGetMySessionRefARATickleMeARACompleteOperationConnection Configuration (CCNF Resource ID 200)A Connection Configuration code resource is executed on the client side when the user selects "Configuration" button on the client in a connection document's security option.  It can store 150 bytes of data in a connection document for a line-level security device.It should display a modal dialog and get any information relevant to connections with line-level security.  You can use ARAReadLockSecurityData, ARAReadSecurityData, ARAWriteSecurityData, and ARAUnlockSecurityData to access and modify the security data.On kSecurityBegin you should get the existing security data.  Once you have obtained the data, you should display a dialog box, and allow the user to modify it.  When the user is done, you can write the security data if it was modified, using ARAWriteSecurityData.The following ARA Service Routines can be used by a CCNF code resource:ARAReadSecurityDataARAReadLockSecurityDataARAUnlockSecurityDataARAWriteSecurityDataARATickleMeARACompleteOperationClient Side Line-level (CLLN Resource ID 200)A client-side line-level code resource is executed after a physical connection has been established, using a connection document configured with security.  It should communicate with the line-level device, prompting the user for any information the device requires.A CLLN code resource can use the ARARead and ARAWrite to communicate with the line-level device on the server.  The data being read or written is sent over the physical line without any packetization.  Your code resource gets control of the line after a connection is established, but before your authentication device allows connection to the ARA server.On kSecurityBegin you should start the communication process with the server line-level device.  You can display a dialog box to obtain information from the user.  Once the physical device has authenticated or rejected the user the code resource should call ARAAllowUser or ARADontAllowUser to let ARA transition to the next state.You can use ARAReadSecurityData to access the 150 bytes of data stored in the connection document.  You can not modify this information during authentication.  The security data is stored in an alias to a remote server as well as the original connection document, so you can get the data even if the connection is initiated from an alias to a remote server.A CLLN code resource can use the following ARA Service Routines:ARAReadARAWriteARAAllowUserARADontAllowUserARAReadSecurityDataARATickleMeARACompleteOperationActionsActions are one of the parameters passed to your code resource's entry routine.  ARA sends them to request a service from your code resource. All actions are sent during main thread time, so you can allocate memory and make calls to Mac Toolbox routines.  The code resource's A5 world is setup prior to calling your routine.  The resource fork of your module is open and on top of the resources stack.You should process actions as quickly as possible.  You should not go into loops and use SystemTask calls as a way of returning control back to ARA.kSecurityStartupkSecurityStartup is sent immediately after your code resource is loaded.  You can allocate any needed memory during the processing of this action, but you should not make any calls to any of the ARA Service Routines.  Once processed, you should return kSecurityNoErr.  Generally you should use kSecurityBegin to start any processing.kSecurityShutdownkSecurityShutdown is the last action sent prior to unloading your code resource.  The code resource will not be called any more after this action.  You can release any allocated memory.  Make sure you have cleaned everything up before returning.  You can not use any of the ARA Service Routines during kSecurityShutdown.kSecurityBeginkSecurityBegin is sent to request your code resource to perform its operation.  E.g. requesting a protocol-level module to authenticate a user.  The code resource should start the operation that it is responsible for.  You can allocate memory and other needed resources.  You can also call ARA Service Routines asynchronously.kSecurityEndkSecurityEnd is sent when the operations that the resource performs are being finished.  You should do your cleanup at this time.  You can not make any calls to ARA Service Routines after or during this action.kSecurityDataAvailablekSecurityDataAvailable is not being used in this release.kSecurityAbortkSecurityAbort is sent when the operation of your code resource is being aborted.  You should stop any further processing by your code resource (including in your completion routine.  E.g. through the use of a flag).  Your code resource should terminate any outstanding asynch calls to routines other than ARA Service Routines.  Outstanding ARA Service Routines will be aborted by ARA.kSecurityTickleActionkSecurityTickleAction is sent to your code resource periodically.  You can also request a kSecurityTickleAction explicitly by calling the ARATicleMe routine.  When you call ARATickleMe you pass an additional parameter which is sent to your "MySecurityProcEntry" as the LongParam.  This additional parameter can be used as a state indicator.  E.g. an asynchronous call has finished, so from your completion routine you call ARATickleMe with the state indicator "DidMyAsynchCall" (this can be a value in an enum).  In processing of kSecurityTickleAction you check the LongParam to see if it matches "DidMyAsynchCall".  If it matches you know you have finished your asynchronous operation and are ready to transition to the next state.  You should also do an ARATickleMe when you need to perform main thread time operations (e.g. allocate memory) .  When kSecurityTickleAction is being sent periodically by ARA LongParam will be 0.  For an example on the use of kSecurityTickleAction and ARATickleMe refer to the Sample module.ARA Service RoutinesARA Service Routines are a set of functions that code resources have access to.  Using these routines, code resources can request ARA services.  The following is a list of ARA Service Routines:ARAReadARAWriteARALogMessageARACallBackAtARAAllowUserARADontAllowUserARAReadSecurityDataARAReadLockSecurityDataARAWriteSecurityDataARAUnlockSecurityDataARAGetUserInfoARATickleMeARACompleteOperationThe following sub-sections describe each of the routines.  NoteAll of the routines expect a MyReference parameter.  This value is passed to "MySecurityProcEntry", and is a unique value representing the instance of the security code resource.ARAReadSyntaxpascal ARAErr    ARARead( SecurityReference        MyReference,                         void                    * DataPtr,                         int                    DataSize,                         SecurityCompletionProc    CompletionProc,                         long                    CompletionParam );DescriptionThis routine is used to issue an asynchronous read call to ARA.  The read will complete either when ARA times out, or the number of bytes requested is read.  This read is used to read data coming from the remote machine.  The protocol-level modules read from each other.  The line-level module reads from a device on the server side.ParametersMyReference is the unique identifier passed to the code resource's entry routine.DataPtr points to a location where the data will be read to.  It must not be released while the asynchronous read has not completed.DataSize is the maximum number of bytes to be read to DataPtr.  The maximum data size is 500 bytes.CompletionProc is a function pointer you provide to be called when the read operation has been completed.  If a time-out occurs the CompletionProc is called with a kARATimeout result code.CompletionParam is additional information you can provide which will be passed to the CompletionProc.Return ValueResult code.  Non kARANoErr result codes are usually because the call was not queued.NoteThis is an asynchronous call and can be called during interrupt time.  The DataPtr field must not be released until the call has completed.See AlsoARAWriteARAWriteSyntaxpascal ARAErr    ARAWrite( SecurityReference            MyReference,                          void                        * DataPtr,                          int                        DataSize,                          SecurityCompletionProc    CompletionProc,                          long                        CompletionParam );DescriptionThis routine can be used to write data to the remote machine.  For protocol-level authentication the data is transferred over a reliable link, whereas for line-level authentication the data is just transferred over the connection without any packetization.  Protocol-level modules write to each other.  Line-level modules write to a security device on the server side.ParametersMyReference is the unique reference passed to the code resource's entry routine.DataPtr is a pointer to the data to be written out.DataSize is the number of bytes to be written.  A maximum of 500 bytes can be written.CompletionProc is a pointer to a completion routine which will be called when the write has been completed.CompletionParam is additional information you can provide which will be passed to the CompletionProc.Return ValueResult code.  Errors are usually caused when the write call can not be queued.NoteThis is an asynchronous call and can be called at interrupt time.  The DataPtr field must not be released until the call has been completed.See AlsoARAReadARALogMessageSyntaxextern pascal ARAErr ARALogMessage( SecurityReference    MyReference,                                    char                * Message,                                    SecurityCompletionProc CompletionProc,                                    long                CompletionParam );DescriptionYou can use this routine to have a message logged to the ARA log file.ParametersMessage is a Pascal string which will be stored in the log file.Return ValueResult code.NoteThis is an asynchronous call that can be made during interrupt time.ARACallBackAtSyntaxpascal ARAErr ARACallBackAt( SecurityReference        MyReference,                               char                    * DialString,                             SecurityCompletionProc    CompletionProc,                             long                    CompletionParam );DescriptionThis routine can be used to change the phone number which ARA will call back at.  In order for this routine to work the call-back must be enabled for the given user.  The call-back won't be executed until all other add-on security modules have been executed.The new number is only used for the current session, and won't change the permanent call-back number.ParametersDialString is a Pascal string which contains the phone number to dial.  It must be a valid phone number.CompletionProc is a routine pointer which will be called when the phone number has been assigned (not when the call-back has been made).CompletionParam can contain additional information you can supply to be passed on to the CompletionProc.Return ValueResult code.NoteThis is an asynchronous call that can be made at interrupt time.The CompletionProc is called when the DialString has been stored by ARA.  Since another security module could override this DialString by another call to this routine, the user may not get called at this DialString.This routine can only be used by a server-side protocol-level code resource (SRPR)ARAAllowUserSyntaxpascal ARAErr  ARAAllowUser( SecurityReference        MyReference,                             SecurityCompletionProc    CompletionProc,                             long                    CompletionParam );DescriptionThis routine is used to let ARA know that the user has been authenticated.  It also informs ARA that the operation has been completed.  ARA will then send the code resource's entry routine a kSecurityEnd action, after which ARA proceeds to the next state.ParametersCompletionProc is a completion routine which will be called when ARA has accepted this call.CompletionParam is additional information you can supply that will be provided to the CompletionProc.Return ValueResult code.NoteThis is an asynchronous call that can be made during interrupt time.See AlsoARADontAllowUser, ARACompleteOperationARADontAllowUserSyntaxpascal ARAErr  ARADontAllowUser( SecurityReference        MyReference,                                 char                    * Message,                                 SecurityCompletionProc    CompletionProc,                                 long                    CompletionParam );DescriptionYou can call this routine when the user has failed authentication.  ARA will send a kSecurityEnd action to the code resources entry routine, after which ARA will tear down the connection.ParametersMessage is an optional Pascal string which states why the user failed authentication.  You can pass a NIL for the pointer.CompletionProc is your routine which will be called when ARA has accepted this call.CompletionParam is a parameter you can supply which is passed to the CompletionProc.Return ValueResult code.NoteThis is an asynchronous call that can be made during interrupt time.See AlsoARAAllowUser, ARACompleteOperationARAReadSecurityDataSyntaxpascal ARAErr  ARAReadSecurityData( SecurityReference    MyReference,                                    void                * DataPtr,                                            int                    DataSize,                            SecurityCompletionProc        CompletionProc,                                    long                CompletionParam );DescriptionThis routine is used to read data for the given type of security module which is associated with either a user or a connection.  On the server this data is associated with a given user.  On the client side this data is associated with the connection.  The maximum amount of data that can be stored is 150 bytes.ParametersDataPtr points to where the security data is to be read to.DataSize is the maximum amount of data to read.  It should not be larger than 150.CompletionProc is a pointer to a routine which will be called when the data has been read.CompletionParam is additional information you can provide to be passed to the CompletionProcReturn ValueResult code.NoteOn the ARA server this data is associated with a given user and stored in the users and groups database.  On the client side this data is associated with a given connection.See AlsoARAReadLockSecurityData, ARAWriteSecurityData, ARAUnlockSecurityDataARAReadLockSecurityDataSyntaxpascal ARAErr  ARAReadLockSecurityData( SecurityReference    MyReference,                                      void                * DataPtr,                                             int                DataSize,                            SecurityCompletionProc        CompletionProc,                                        long                CompletionParam );DescriptionThis routine is used to read and lock data for the given type of security module which is associated with either a user or a connection.  On the server this data is associated with a given user.  On the client side this data is associated with the connection.  The maximum amount of data that can be read or written is 150 bytes.  You should use the ARAReadLockSecurityData instead of ARAReadSecurityData if you plan to modify or write the security data.  This is crucial on the server, because you can have multiple threads attempting to modify the same data.ParametersDataPtr points to where the security data is to be read to.DataSize is the maximum amount of data to read.  It should not be larger than 150.CompletionProc is a pointer to a routine which will be called when the data has been read.CompletionParam is additional information you can provide to be passed to the CompletionProcReturn ValueResult code.NoteOn the ARA server this data is associated with a given user and stored in the users and groups database.  On the client side this data is associated with a given connection.You must call ARAUnlockSecurityData to remove the lock from the security data.See AlsoARAReadSecurityData, ARAWriteSecurityData, ARAUnlockSecurityDataARAWriteSecurityDataSyntaxpascal ARAErr ARAWriteSecurityData( SecurityReference    MyReference,                                    void                * DataPtr,                                    int                    DataSize,                               SecurityCompletionProc    CompletionProc,                                    long                CompletionParam );DescriptionThis routine can be used by the security modules (mostly configuration code resources) to store configuration data which is associated with either a user or a connection.  On the server this data is associated with a user.  On the client this data is associated with a connection.ParametersDataPtr points to the data to be stored.DataSize is the number of bytes to store.  It should be less than or equal to 150.CompletionProc is a pointer to a completion routine that will be called when the data has been written.CompletionParam is additional information you can provide to be passed to the CompletionProc.Return ValueResult code.NoteOn the ARA server this data is associated with a given user and stored in the users and groups database.  On the client side this data is associated with a given connection.A line-level authentication code resource (CLLN) can not modify the security data.See AlsoARAReadSecurityData, ARAReadLockSecurityData, , ARAUnlockSecurityDataARAUnlockSecurityDataSyntaxpascal ARAErr ARAUnlockSecurityData( SecurityReference    MyReference,                               SecurityCompletionProc    CompletionProc,                                      long                CompletionParam );DescriptionThis routine removes a lock from security data that has been locked using ARAReadLockSecurityData.ParametersCompletionProc is a pointer to a completion routine that will be called when the data has been written.CompletionParam is additional information you can provide to be passed to the CompletionProc.Return ValueResult code.NoteYou must call ARAUnlockSecurityData after you have called ARAReadLockSecurityData.See AlsoARAReadSecurityData, ARAReadLockSecurityData, ARAWriteSecurityDataARAGetUserInfoSyntaxpascal ARAErr    ARAGetUserInfo( SecurityReference    MyReference,                                void                * DataPtr,                                int                    DataSize,                                SecurityCompletionProc    CompletionProc,                                long                CompletionParam );DescriptionThis routine is used to get information about the user.  Currently it returns the user's name.  On the server this is the information for the user dialing in, or being configured.ParametersDataPtr points to where this information will be stored.DataSize is the maximum number of bytes to be read.CompletionProc is a completion routine that will be called when the information has been read.CompletionParam is additional information you can provide to be passed to the CompletionProc.Return ValueResult code.ARATickleMeSyntaxpascal ARAErr    ARATickleMe( SecurityReference        MyReference,                             long                    TickleParam );DescriptionThis routine causes ARA to send a  kSecurityTickleAction to the code resource's entry routine.  For example, you can use this routine from completion routines to have your entry routine invoked.ParametersTickleParam is additional information you can provide which will be passed to the entry routine in its LongParam parameter.  When ARA calls the entry routine with a kSecurityTickleAction it passes a 0 for the LongParam parameter.  You can use this as a state indicator.Return ValueResult code.NoteThis function can be called during interrupt time.  The kSecurityTickleAction is sent to the "MySecurityProcEntry" at SystemTask time.See AlsokSecurityTickleActionARACompleteOperationSyntaxpascal ARAErr    ARACompleteOperation( SecurityReference     MyReference );DescriptionYou call this routine when you need to end the operation the code resource is performing.  It causes ARA to send a kSecurityEnd action.  For example the configuration code resource should call this routine when the user has finished inputting information into its dialog box.ParametersMyReference is the unique reference passed to the code resource's entry routine.Return ValueResult code.See AlsokSecurityBegin, and kSecurityEnd actionsAppendix A:  Security Interface Header File//234567890123456789012345678901234567890123456789012345678901234567890123456789//===========================================================================//    File:    SecurityInterface.h////    This file is the header file which a third party security vendor can//    use to create an add-on security module.  The add-on security modules//    can be used to integrate a security device with Apple Remote Access.////    Copyright © 1992, 1993 Apple Computer Inc.//    All rights reserved////    Author:  Farzad Sarabi////    Modification history:////    9/29/1993    Farzad        Removed declarations for some routines that were//                            obsolete.//    2/15/1993    Farzad        The A5 world and a working environment is now//                            setup for the security modules.  As a result of//                            this some of the routines in this module are//                            obsolete.  Among these are ARAGet/SetMyPrivateData,//                            ARAGetMyResFile.//    10/6/1992    Farzad        Created//===========================================================================#ifndef SECURITY_INTERFACE#define SECURITY_INTERFACE 1#ifndef __FILES__#include    <Files.h>#endif#ifndef SECURITY_PUBLIC#include    "SecurityPublic.h"#endif//===========================================================================//    Macros//===========================================================================#define kSecurityInterfaceVersion 0x0100    // 0x0100 will be release 1#ifdef __cplusplusextern "C"    {                // in case we are linking into C++ code#endif//===========================================================================//    Types//===========================================================================// actions are defined in the SecurityPublic.h file// ARAErr is defined in SecurityPublic.h// SecurityEntryProc is defined in SecurityPublic.h// SecurityCompletionProc is defined in SecurityPublic.h//===========================================================================//    Data//===========================================================================//===========================================================================//    Functions//===========================================================================// the following are functions you can call to have AppleTalk Remote Access// perform these servicesextern pascal ARAErr    ARARead( SecurityReference        MyReference,                                 void                    * DataPtr,                                 int                    DataSize,                                 SecurityCompletionProc    CompletionProc,                                 long                    CompletionParam );//===========================================================================//    Description:    this routine is used to post an asynchronous read//                    operation for data coming from the remote machine.//                    This routine can be used by line-level and protocol-level//                    authentication modules.  It is not available for //                    configuration modules.////    Parameters:        MyReference        this module's unique reference//                    DataPtr            where to put the read data//                    DataSize        the maximum number of bytes to read//                    CompletionProc    this routine will be called when the//                                    read request has finished//                    CompletionParam    this is information you can provide to//                                    be passed to the completion proc////    Return Value:    ARAErr            result code, nonzero indicates an error////    Creation Date:    10/6/1992////    Modifications:////===========================================================================extern pascal ARAErr    ARAWrite( SecurityReference            MyReference,                                  void                        * DataPtr,                                  int                        DataSize,                                  SecurityCompletionProc    CompletionProc,                                  long                        CompletionParam );//===========================================================================//    Description:    this routine is used to asynchronously write data to//                    the remote machine.  It can be used by line-level and//                    protocol-level authentication modules.////    Parameters:        MyReference        your unique reference//                    DataPtr            the data to be written out//                    DataSize        the amount of data to write//                    CompletionProc    this routine is called when the data//                                    has been written out//                    CompletionParam    this is extra information you can provide//                                    to be passed to the CompletionProc////    Return Value:    ARAErr            result code, nonzero indicates an error////    Creation Date:    10/6/1992////    Modifications:////===========================================================================extern pascal ARAErr ARALogMessage( SecurityReference        MyReference,                                    char                    * Message,                                    SecurityCompletionProc    CompletionProc,                                    long                    CompletionParam );//===========================================================================//    Description:    you can use this routine to put a message in AppleTalk//                    remote accesses log file.////    Parameters:        MyReference        your unique reference//                    Message            a Pascal string which will be logged to//                                    in the log file//                    CompletionProc    this routine will be called when the//                                    log message has been completed.//                    CompletionParam    additional information you can supply to//                                    be passed on to the completion proc////    Return Value:    ARAErr            result code, nonzero indicates an error////    Creation Date:    10/6/1992////    Modifications:////===========================================================================extern pascal ARAErr ARACallBackAt( SecurityReference        MyReference,                                    char                    * DialString,                                    SecurityCompletionProc    CompletionProc,                                    long                    CompletionParam );//===========================================================================//    Description:    this routine can be used during authentication to//                    cause the server to call the client back at the//                    specified number.////    Parameters:        MyReference        your unique reference//                    DialString        this is a pascal string which must//                                    contain a dial string for the number//                                    to call the client back at//                    CompletionProc    this proc will be called when the callback//                                    has been completed.//                    CompletionParam    additional information you can provide//                                    that will be passed to the CompletionProc////    Return Value:    ARAErr            result code, nonzero indicates an error////    Creation Date:    10/6/1992////    Modifications:////===========================================================================extern pascal ARAErr  ARAAllowUser( SecurityReference        MyReference,                                    SecurityCompletionProc    CompletionProc,                                    long                    CompletionParam );//===========================================================================//    Description:    the authentication code on the server can call this//                    routine to indicate the user has passed this module's//                    security requirements.////    Parameters:        MyReference        your unique reference//                    CompletionProc    this routine is called when AppleTalk//                                    Remote Access has finished handling//                                    your authentication information.////    Return Value:    ARAErr            result code, nonzero indicates an error////    Creation Date:    10/6/1992////    Modifications:////===========================================================================extern pascal ARAErr  ARADontAllowUser( SecurityReference        MyReference,                                        char                    * Message,                                        SecurityCompletionProc    CompletionProc,                                        long                    CompletionParam );//===========================================================================//    Description:    the server security module can call this routine to//                    prevent a user from being allowed in.////    Parameters:        MyReference        your unique reference//                    Message            a pascal string stating why the user//                                    was not allowed access//                    CompletionProc    this routine will be called when the//                                    request for not allowing user has bee//                                    processed//                    CompletionParam    additional information you can provide//                                    which will be passed to the completion//                                    proc////    Return Value:    ARAErr            result code, nonzero indicates an error////    Creation Date:    10/6/1992////    Modifications:////===========================================================================extern pascal ARAErr  ARAReadSecurityData( SecurityReference    MyReference,                                           void                    * DataPtr,                                           int                    DataSize,                                    SecurityCompletionProc        CompletionProc,                                           long                    CompletionParam );//===========================================================================//    Description:    this routine can be used to read data for this security//                    module which is associated with either a user (on the//                    server side), or a connection (on the client side).//                    This routine doesn't lock the data, so use it only when//                    you just plan to read the data.////    Parameters:        MyReference        your unique reference//                    DataPtr            where the data will be read to//                    DataSize        maximum number of bytes to read//                    CompletionProc    this routine will be called when the//                                    read request has completed//                    CompletionParam    additional information you can provide//                                    to be passed to the completion proc////    Return Value:    ARAErr            result code, nonzero indicates an error////    Creation Date:    10/6/1992////    Modifications:////===========================================================================extern pascal ARAErr ARAReadLockSecurityData( SecurityReference    MyReference,                                              void                * DataPtr,                                              int                DataSize,                                        SecurityCompletionProc    CompletionProc,                                              long                CompletionParam );//===========================================================================//    Description:    this routine can be used to read security data and lock//                    it to be modified.  If you are planning on modifying your//                    data and then writing it, you must call this routine.//                    It locks the data until the a ARAUnlockSecurityData call.////    Parameters:        MyReference        your unique reference//                    DataPtr            where the data will be read//                    DataSize        the maximum number of bytes to read//                    CompletionProc    this routine will be called when the//                                    data is read into your buffer.//                    CompletionParam    additional information you can provide to//                                    be passed on to the CompletionProc.////    Return Value:    ARAErr            result code, nonzero indicates an error////    Creation Date:    10/29/1992////    Modifications:////===========================================================================extern pascal ARAErr    ARAUnlockSecurityData( SecurityReference    MyReference,                                            SecurityCompletionProc    CompletionProc,                                               long                    CompletionParam );//===========================================================================//    Description:    if you have read the security data with ARAReadLockSecurityData//                    you must call this routine to unlock the data.  After this//                    call others can then lock the security data.////    Parameters:        MyReference        your unique reference//                    CompletionProc    this routine is called when the data is unlocked//                    CompletionParam    additiona information you can provide to be//                                    passed to the CompletionProc////    Return Value:    ARAErr            result code, nonzero indicates an error////    Creation Date:    10/29/1992////    Modifications:////===========================================================================extern pascal ARAErr ARAWriteSecurityData( SecurityReference    MyReference,                                           void                    * DataPtr,                                           int                    DataSize,                                       SecurityCompletionProc CompletionProc,                                           long                CompletionParam );//===========================================================================//    Description:    this routine can be used by the module to write private//                    data which is either associated with a user (on the server//                    side), or a connection (on the client side).////    Parameters:        MyReference        your unique reference//                    DataPtr            the data to be written out//                    DataSize        the amount of data to write out//                    CompletionProc    this routine is called when AppleTalk//                                    Remote Access has completed the write//                                    operation//                    CompletionParam    additional information you can provide//                                    which is passed to the completion proc////    Return Value:    ARAErr            result code, nonzero indicates an error////    Creation Date:    10/6/1992////    Modifications:////===========================================================================extern pascal ARAErr    ARAGetUserInfo( SecurityReference    MyReference,                                        void                * DataPtr,                                        int                    DataSize,                                    SecurityCompletionProc    CompletionProc,                                        long                CompletionParam );//===========================================================================//    Description:    this routine can be called to get information about the//                    the user, such as user name etc.  It is an asynchronous//                    call.////    Parameters:        MyReference        your unique code reference//                    DataPtr            pointer to where the user's name (Pascal//                                    string) will be stored//                    DataSize        maximum number of bytes to read//                    CompletionProc    this routine will be called when the call//                                    has completed//                    CompletionParam    additional information to be passed to//                                    the CompletionProc////    Return Value:    ARAErr            result code, nonzero indicates an error////    Creation Date:    10/6/1992////    Modifications:////===========================================================================extern pascal long    ARAGetMySessionRef( SecurityReference    MyReference );//===========================================================================//    Description:    You can call this routine to obtain the session reference//                    for the connection for which your code is loaded.  This//                    value is unique and stays the same during the connection.//                    If you have a security module which has both a line-level//                    and a protocol-level authentication, you can use this//                    unique reference as a key to communicate between the//                    code resources.////    Parameters:        MyReference        this is your code's unique reference////    Return Value:    long            the session reference, NULL if there is an//                                    error////    Creation Date:    10/29/1992////    Modifications:////===========================================================================extern pascal ARAErr    ARATickleMe( SecurityReference        MyReference,                                     long                    TickleParam );//===========================================================================//    Description:    this routine can be used to have AppleTalk Remote Access//                    call your entry routine with a kSecurityTickleAction.//                    You can also provide some additional information which//                    is passed to the entry routine.////    Parameters:        MyReference        your unique reference//                    TickleParam        additional information you can provide//                                    which is passed to the entry proc////    Return Value:    ARAErr            result code, nonzero indicates an error////    Creation Date:    10/6/1992////    Modifications:////===========================================================================extern pascal ARAErr ARACompleteOperation( SecurityReference     MyReference );//===========================================================================//    Description:    this routine can be called to terminate an operation.//                    It causes ARA to send a kSecurityEnd action.  During//                    configuration for example the code resource can call//                    this routine to indicate that configuration has//                    completed.////    Parameters:        MyReference        your unique reference////    Return Value:    ARAErr            result code, nonzero indicates an error////    Creation Date:    10/6/1992////    Modifications:////===========================================================================#ifdef __cplusplus}#endif#endif // SECURITY_INTERFACEAppendix B:  Security Module Shell//234567890123456789012345678901234567890123456789012345678901234567890123456789//===========================================================================//    File:    SecurityShell.c////    This file contains a shell for add-on security modules for Apple//    Remote Access.  This code can be duplicated to write an add-on//    security code module.////    Copyright © 1992, 1993 Apple Computer Inc.//    All rights reserved////    Author:  Farzad Sarabi////    Modification history:////    5/10/1993    Farzad        A little cleanup, and added a completion routine.//                            Some more comments//    10/6/1992    Farzad        Created//===========================================================================#include    "SecurityInterface.h"// #define SecurityShellVersion 0x0100//===========================================================================//    Example of Your Code//===========================================================================// function prototypesstatic long        DoMyStartup( SecurityReference    MyReference,                             long                LongParam );static long        DoMyShutdown( SecurityReference        MyReference,                              long                    LongParam );static long        DoMyBegin( SecurityReference    MyReference,                           long                    LongParam );static long        DoMyEnd( SecurityReference    MyReference,                         long                LongParam );static long        DoMyDataHandler( SecurityReference    MyReference,                                 long                LongParam );static long        DoMyAbortHandler( SecurityReference        MyReference,                                  long                    LongParam );static long        DoMyTickleHandler( SecurityReference    MyReference,                                   long                    LongParam );pascal void        MyCompletionProc( SecurityReference        MyReference,                                  int                    ResultCode,                                  void                    * DataPtr,                                  int                    DataSize,                                  long                    CompletionParam );// the following is a shell for your code.  It shows how your entry routine// should be structured.  Empty supporting routines for the actions are// provided.// WARNING://        Don't change the name of this routine.  We may change it in the//        future.  This is the routine ARA expects and calls.pascal long        MySecurityProcEntry( SecurityActions        Action,                                     SecurityReference        MyReference,                                     long                    LongParam )//===========================================================================//    Description:    this is the entry point for the ??? security operation.//                    It is called by AppleTalk Remote Access to have this//                    security module perform the given operation.  It//                    dispatches to a variety of routines based on the//                    requested action.////    Parameters:        Action                the action to be performed//                    MyReference            this is a unique value representing//                                        this instance of this code module.//                    DataPtr                the data for this action//                    DataSize            the size of data////    Return Value:    long                result code, nonzero indicates an//                                        error.  Its value is one of the//                                        SecurityResultCodes.////    Creation Date:////    Modifications:////==========================================================================={    switch ( Action )    {      case    kSecurityStartup:        return DoMyStartup( MyReference, LongParam );      case    kSecurityShutdown:          return DoMyShutdown( MyReference, LongParam );      case    kSecurityBegin:          return DoMyBegin( MyReference, LongParam );      case    kSecurityEnd:          return DoMyEnd( MyReference, LongParam );      case    kSecurityDataAvailable:        return DoMyDataHandler( MyReference, LongParam );      case    kSecurityAbort:        return DoMyAbortHandler( MyReference, LongParam );      case    kSecurityTickleAction:          return DoMyTickleHandler( MyReference, LongParam );    }    return ( kSecurityUnsupportedAction );}static long        DoMyStartup( SecurityReference    MyReference,                             long                LongParam )//===========================================================================//    Description:    this routine handles the kSecurityStartup action.  You//                    should allocate any memory and setup the working//                    environment (e.g. A5 world) here.////    Parameters:        MyReference        My unique reference//                    LongParam        additional information////    Return Value:    long            result code, nonzero indicates error////    Creation Date:////    Modifications:////==========================================================================={#pragma unused(MyReference)#pragma unused(LongParam)    // this routine is called when the module has just been loaded.  You    // can preallocate any memory you need.  You are not yet starting any    // to do what this code resource is responsible for.    // You can allocate and release memory in this routine.    return ( kSecurityNoErr );}static long        DoMyShutdown( SecurityReference        MyReference,                              long                    LongParam )//===========================================================================//    Description:    this routine handles the kSecurityShutdown action.  You//                    should release any memory allocated by the DoMyStartup//                    routine.////    Parameters:        MyReference        My unique reference//                    LongParam        additional information////    Return Value:    long            result code, nonzero indicates error////    Creation Date:////    Modifications:////==========================================================================={#pragma unused(MyReference)#pragma unused(LongParam)    // this is the last routine that is called before your code resource    // is released.  Just do any cleanup you need to perform.  ARA services    // are no longer available.    // You can allocate and release memory in this routine.    return ( kSecurityNoErr );}static long        DoMyBegin( SecurityReference    MyReference,                           long                    LongParam )//===========================================================================//    Description:    this routine handles the kSecurityBeing action.  This//                    routine should start the operations the code resource//                    must do.  For example an authentication code resource//                    should start the authentication process.////    Parameters:        MyReference        My unique reference//                    LongParam        additional information////    Return Value:    long            result code, nonzero indicates error////    Creation Date:////    Modifications:////==========================================================================={#pragma unused(MyReference)#pragma unused(LongParam)    // This routine is called to actually start the code resource to do    // what it's responsible for.  E.g. an authentication code resource    // should start the authentication process.  A configuration module    // can start displaying a dialog etc.    // You can allocate and release memory in this routine.    return ( kSecurityNoErr );}static long        DoMyEnd( SecurityReference    MyReference,                         long                LongParam )//===========================================================================//    Description:    this routine handles the kSecurityEnd action.  The action//                    is sent to signal the end of the operation the code//                    resource was created to do.////    Parameters:        MyReference        My unique reference//                    LongParam        additional information////    Return Value:    long            result code, nonzero indicates error////    Creation Date:////    Modifications:////==========================================================================={#pragma unused(MyReference)#pragma unused(LongParam)    // This routine is called when the code resource is finished.  It is    // called as a result of you calling ARAAllowUser, ARADontAllowUser,    // ARACompleteOperation, or after ARA aborts your code resource.    // You could for example cleanup any outstanding asynch calls to the    // Mac OS.  ARA services are no longer available.    // You can allocate and release memory in this routine.    return ( kSecurityNoErr );}static long        DoMyDataHandler( SecurityReference    MyReference,                                 long                LongParam )//===========================================================================//    Description:    this routine handles the kSecurityDataAvailable action.//                    The action is sent when data has arrived for the code//                    resource.////    Parameters:        MyReference        My unique reference//                    LongParam        additional information////    Return Value:    long            result code, nonzero indicates error////    Creation Date:////    Modifications:////==========================================================================={#pragma unused(MyReference)#pragma unused(LongParam)    // This routine is not used in this release of the ARA Add-on Security.    // In future releases we may use this to indicate data being available    // for you.  ARA may in the future send events to a modeless dialog    // box using the DataAvailable message.    // You can allocate and release memory in this routine.    return ( kSecurityNoErr );}static long        DoMyAbortHandler( SecurityReference        MyReference,                                  long                    LongParam )//===========================================================================//    Description:    this routine handles the kSecurityAbort action.  The//                    abort action is sent when the code resources operation//                    needs to be terminated abnormally.////    Parameters:        MyReference        My unique reference//                    LongParam        additional information////    Return Value:    long            result code, nonzero indicates error////    Creation Date:////    Modifications:////==========================================================================={// you can remove the unused pragma for any of the parameters you use#pragma unused(MyReference)#pragma unused(LongParam)    // This routine is called when the code resource is being aborted.    // You should not make any more calls to ARA services, and you should    // start your abort process.  You will receive the End and Shutdown    // actions a little while later.    // You can allocate and release memory in this routine.    return ( kSecurityNoErr );}static long        DoMyTickleHandler( SecurityReference    MyReference,                                   long                    LongParam )//===========================================================================//    Description:    this routine handles the kSecurityTickle action.  ARA//                    sends this action periodically.  The action is also//                    generated as a result of a call to ARATickleMe routine.//                    ////    Parameters:        MyReference        My unique reference//                    LongParam        When ARA calls this value will be 0,//                                    otherwise it is the value passed to//                                    the ARATickleMe routine.////    Return Value:    long            result code, nonzero indicates error////    Creation Date:////    Modifications:////==========================================================================={// you can remove the unused pragma for any of the parameters you use#pragma unused(MyReference)#pragma unused(LongParam)    // ARA calls this routine periodically.  You can also initiate a call    // to this routine by calling ARATickleMe.  When ARA calls this    // routine the LongParam value will be 0 (zero).  When it is called as    // a result of a call to ARATickleMe the LongParam will have the value    // you passed to ARATickleMe.    // You can allocate and release memory in this routine.    return ( kSecurityNoErr );}pascal void        MyCompletionProc( SecurityReference        MyReference,                                  int                    ResultCode,                                  void                    * DataPtr,                                  int                    DataSize,                                  long                    CompletionParam )//===========================================================================//    Description:    this is an example of your a completion routine you can//                    use for calls to asynch ARA services.  You can use one//                    completion proc and distinguish the reason it was called//                    by the value passed in the CompletionParam.//                    ////    Parameters:        MyReference        your unique reference//                    ResultCode        result of the asynch ARA call you made//                    DataPtr            pointer to the data passed to the ARA//                                    proc//                    DataSize        actual size of the data//                    CompletionParam    additional information you provided //                                    to the ARA service proc////    Return Value:    none////    Creation Date:////    Modifications:////==========================================================================={// you can remove the unused pragma for any of the parameters you use#pragma unused(MyReference)#pragma unused(ResultCode)#pragma unused(DataPtr)#pragma unused(DataSize)#pragma unused(CompletionParam)    // WARNING:    //            Do not attempt to allocate or release any memory in this    //            routine.  Also don't call any Mac Toolbaox/OS routines     //            that allocate or release memory.  If you need to do this,    //            you should call ARATickleMe with a state indicator, and    //            allow your DoMyTickle routine to handle it.    return;}Appendix C:  MiscellaneousRuntime EnvironmentARA builds an A5 world for a code resource, so the module can have its own global data.  ARA sets the A5 world automatically, prior to calling any routines (entry, completion) in the code resource.The module inherits stacks from other executing tasks, and should refrain from recursion and large stack variables.The resource file from which the code resources are loaded will be on the top of the resource file stack, when ARA executes code resources.  The security module's resource file is opened as read-only, and you should not attempt to modify or add any resources.You must initialize any Toolbox manager's you are using (e.g. InitGraf).Building  an Add-on Security ModuleYou need MPW 3.2 or later and MPW C to build a security module.  The ARA Security Interface disk contains the files you need to build a security interface.The EmptyShell is a good starting point for putting together a code resource.  You can also use the sample module as the starting point for your module.  This code can be used in your security modules, but you must keep Apple's copyrights in the source files.After you have designed your security module (e.g. line-level vs. protocol-level and its working behavior), take the "SecurityShell.c" and code the routines that handle the actions.  The Sample Module shows how a protocol-level module that provides a second password is coded.You must also define the proper 'sinf' resource for your module.After you have compiled the module you must link it with "SecurityInterface.o".  You must also link in "Runtime.o" (included with MPW).  SecurityInterface.o must be the first file in the link command.  The link command should also have "-m SECURITYINTERFACEENTRYPROC".For an example of how a security module is build Review the enclosed Sample Module.ARA Security Interface DiskThe enclosed developer disk contains the interface files and sample modules you can use to build an ARA security module.  This sections describes the contents of this disk.The "Empty Shell" folder contains a file you can use to build a code resource file.  It contains place holder routines for processing the ARA actions.The "Sample Protocol Module" folder contains the complete source for a security module that provides a second password.  Using this module, you can assign each user a second password.  This is a protocol-level module.  You can use this code as a starting point for building your own module."Security Interfaces" folder contains the various header files for interfacing with ARA.  "SecurityInterface.h", and "SecurityPublic.h" contain all the declarations that your module needs for accessing ARA Service Routines.  "SecurityResInfo.h" contains the flags that are used in the 'sinf' resource.  "SecurityTypes.r" has the resource declarations for a security module."SecurityLibraries" contains "SecurityInterface.o" that must be linked as the first file for each of your code resources.
ºdˇˇˇˇˇd

d,Times
.ˇ°dONLNdÅ~ôê+~ì
,Palatino°dONLNd≤~À
k*1Apple Remote Access°dONLNdÀ~‰
ô*Add-on Security Interface
°dONLNd0L6Xö(U6Author:  Farzad Sarabi°dONLNdGX6dg*Version 1.0°dONLNdSd6pÖ*November 4, 1993°dONLNddà6î
*$+Copyright © 1992, 1993 Apple Computer, Inc.ˇ3Ódˇˇˇˇˇd

d,Times
.ˇ°dONLNdB
N
_(K
Table of Contents,Palatino
°dONLNdk6wm(t6Introduction°dONLNdˇˇ)9 ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P...........°dONLNdˇˇ)
1°dONLNd!|6àa(Ö6Overview°dONLNdˇˇ)/ ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P...............°dONLNdˇˇ)'
2°dONLNd,ç6ô™(ñ6Security Module Structure°dONLNdˇˇ)w ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P..................°dONLNdˇˇ)/
5°dONLNdHôZ•
(¢Z+Module Information Resource ('sinf' ID 200)°dONLNdˇˇ)ƒ ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P.....°dONLNdˇˇ)
6°dONLNdv•Z±«(ÆZCode Resource Structure°dONLNdˇˇ)o ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P.......°dONLNdˇˇ)
8°dONLNdê±ZΩ
(∫Z)User Configuration (UCNF Resource ID 200)°dONLNdˇˇ)… ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P...°dONLNdˇˇ)    11°dONLNdΩΩZ…t(ΔZClientE °dONLNd√Ωu…
)%-side Protocol (CLPR Resource ID 200)°dONLNdˇˇ)´ ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P....°dONLNdˇˇ)12°dONLNdÏ…Z’v(“ZServerfiÄ°dONLNdÚ…v’
)%-side Protocol (SRPR Resource ID 200)°dONLNdˇˇ)™ ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P.....°dONLNdˇˇ)13°dONLNd
’Z·
=(fiZ/Connection Configuration (CCNF Resource ID 200)°dONLNdˇˇ)‰ ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P........................°dONLNdˇˇ)>14°dONLNd
N·ZÌ
'(ÍZ-Client Side Line-level (CLLN Resource ID 200)°dONLNdˇˇ)– ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)R15°dONLNd
Ú6˛W(˚6Actions°dONLNdˇˇ)% ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P...................°dONLNdˇˇ)116°dONLNd
ä˛Z

§(
ZkSecurityStartup°dONLNdˇˇ)L ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P.....................°dONLNdˇˇ)616°dONLNd
û

Z
±(
ZkSecurityShutdown°dONLNdˇˇ)[ ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P...............°dONLNdˇˇ)'16°dONLNd
≥
Z
"ú(
ZkSecurityBegin°dONLNdˇˇ)D ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P........................°dONLNdˇˇ)>16°dONLNd
≈
"Z
.ï(
+ZkSecurityEnd°dONLNdˇˇ)= ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P...........................°dONLNdˇˇ)E16°dONLNd
’
.Z
:√(
7ZkSecurityDataAvailable°dONLNdˇˇ)j ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P    .........°dONLNdˇˇ)16°dONLNd
Ô
:Z
Fù(
CZkSecurityAbort°dONLNdˇˇ)G ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P.......................°dONLNdˇˇ);16°dONLNd

FZ
Rº(
OZkSecurityTickleAction°dONLNdˇˇ)e ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P...........°dONLNdˇˇ)17°dONLNd
W6
cò(
`6ARA Service Routines°dONLNdˇˇ)c ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P..........................°dONLNdˇˇ)C18°dONLNd2
cZ
oÜ(
lZARARead°dONLNdˇˇ). ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P
.°dONLNdˇˇ)19°dONLNd=
oZ
{â(
xZARAWrite°dONLNdˇˇ)0 ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)R21°dONLNdI
{Z
áß(
ÑZARALogMessage°dONLNdˇˇ)N ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P....................°dONLNdˇˇ)422°dONLNdZ
áZ
ì¢(
êZARACallBackAt°dONLNdˇˇ)I ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P......................°dONLNdˇˇ)923°dONLNdk
ìZ
ü†(
úZARAAllowUser°dONLNdˇˇ)G ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P.......................°dONLNdˇˇ);24°dONLNd{
üZ
´∂(
®ZARADontAllowUser°dONLNdˇˇ)` ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P.............°dONLNdˇˇ)"25°dONLNdè
´Z
∑ø(
¥ZARAReadSecurityData°dONLNdˇˇ)g ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P
..........°dONLNdˇˇ)26°dONLNd¶
∑Z
√’(
¿ZARAReadLockSecurityData°dONLNdˇˇ)~ ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P
.°dONLNdˇˇ)27°dONLNd¡
√Z
œ¬(
ÃZARAWriteSecurityData°dONLNdˇˇ)j ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P    .........°dONLNdˇˇ)28°dONLNdŸ
œZ
€…(
ÿZARAUnlockSecurityData°dONLNdˇˇ)q ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P......°dONLNdˇˇ)29°dONLNdÚ
€Z
Á¶(
‰ZARAGetUserInfo°dONLNdˇˇ)N ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P....................°dONLNdˇˇ)430°dONLNd
ÁZ
Ûô(
ZARATickleMe°dONLNdˇˇ)B ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P.........................°dONLNdˇˇ)@31°dONLNd
ÛZ
ˇ»(
¸ZARACompleteOperation°dONLNdˇˇ)o ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P.......°dONLNdˇˇ)32°dONLNd+6˜(6+Appendix A:  Security Interface Header File°dONLNdˇˇ)≈ ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P...................°dONLNdˇˇ)133°dONLNdZ6!‘(6"Appendix B:  Security Module Shell°dONLNdˇˇ)ü ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P..°dONLNdˇˇ)41°dONLNdÄ&62≤(/6Appendix C:  Miscellaneous°dONLNdˇˇ) ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P...............°dONLNdˇˇ)'48°dONLNdû2Z>Ω(;ZRuntime Environment°dONLNdˇˇ)e ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P...........°dONLNdˇˇ)48°dONLNdµ>ZJ

(GZ#Building  an Add-on Security Module°dONLNdˇˇ)® ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P................°dONLNdˇˇ)*48°dONLNd‹JZV◊(SZARA Security Interface Disk°dONLNdˇˇ)~ ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P ................................°dONLNdˇˇ)P
.°dONLNdˇˇ)49ˇ
ûdˇˇˇˇˇd

d,    Helvetica
    .ˇ+$,ARA Add-on Security Interface(,Version 1.0,Palatino°dONLNdB6RÜ(N6Introduction R4R/
°dONLNdgZs    +$"^This document describes the add-on security interface used in Apple Remote Access (ARA).  Thiså°dONLNdlyZÖ    *`document is written for a security module writer, and explains the ARA interface as seen from an°dONLNdÕãZóΔ*add-on security module.äf°dONLNdÂßZ≥    *WAdd-on security modules (security modules) contain code resources that allow additionalç´°dONLNd
=πZ≈    *]methods of authenticating users.  ARA uses passwords and a call-back mechanism as its default
÷°dONLNd
õÀZ◊    *\security.  If you have a system for identifying a user, you can develop a security module to°dONLNd
¯›ZÈ
3*/integrate your authentication methods into ARA.⁄°dONLNd(˘Z
    *^We have defined two types of security devices.  Devices that sit in front of or behind a modem
„–°dONLNdá
Z

 *Pand physically prevent a connection prior to user authentication are called lineìê°dONLNd◊

 
    (

 -level security*M°dONLNdÁ
Z
)    (
&Z\devices.  Systems that perform their authentication after the ARA server and its client have“Ö°dONLNdD
/Z
;    *\established a connection are classified as protocol-level security devices.  You can develop°dONLNd°
AZ
M
*)security modules for each type of device.°dONLNdÀ
]Z
i
Ñ*CThe next section gives a brief overview of add-on security modules.°dONLNd
yZ
Ö
Ë*ZThe Security Module Structure section describes a module and its structure in more detail.
~‰°dONLNdj
ïZ
°    *^The Code Resources section describes the different kinds of code resources that can exist in a°dONLNd…
ßZ
≥§*security module.°dONLNd⁄
√Z
œ
Á*ZThe Actions section describes the actions ARA sends to code resources to request services.°dONLNd5
flZ
Î*^The ARA Service Routines section describes the services that ARA provides to security modules.°dONLNdî
˚Z
ü*IAppendix A is the header file for gaining access to ARA Service Routines.°dONLNdfiZ#
]*:Appendix B is an empty shell for building a code resource.d¢°dONLNd3Z?    *WAppendix C contains miscellaneous information about security module's such as a modules°dONLNdqEZQ
˙*Zruntime environment, how you can build a module, and the enclosed developer disk contents.
    (Ú$*Copyright © 1992, 1993 Apple Computer Inc.(Ú;
1ˇÓdˇˇˇˇˇd

d,    Helvetica
    .ˇ+$,ARA Add-on Security Interface(,Version 1.0,Palatino°dONLNdB6Rt(N6Overview R4R/

µ^°dONLNd    gZs    +$"\A security module is a Macintosh file type 'CLMP'.  The creator is vendor specific.  You can°dONLNdfyZÖ
Ì*Xrequest a creator for your security module from Apple Developer Technical Support (DTS).<2°dONLNdøïZ°    *_Internally a security module contains a number of special resources.  Every module must containˇˇÎX°dONLNd
ßZ≥    *_an information resource that describes your modules capabilities.  Additionally your module may'°dONLNd
πZ≈    *Ycontain a number of code resources.  These code resources are executed to perform various‘G°dONLNd
ŸÀZ◊    *_functions (e.g. authentication, configuration) for your security module.  ARA then can use yourìÑ°dONLNd9›ZÈ    *]module to authenticate a user's identity beyond the password mechanism that it contains.  ARA°dONLNdóÔZ˚
W*:security modules that are placed in the Extensions folder.
    (Ú$*Copyright © 1992, 1993 Apple Computer Inc.(Ú;
2ˇ'~dˇˇˇˇˇd

d,    Helvetica
    .ˇ+$,ARA Add-on Security Interface(,Version 1.0,Palatino
°dONLNd6ZB
Ö(?ZDThe following diagram illustrates the contents of a security module:°ddPro
†Ç°‘
°d
dPro    †å

J|*
Á    à"à"à"à"qö
8†
Bù
B†
8ù
8ö
8ù
B"ù
#†ç°ddPro
°d
dPro    †åqÕ
í”
ú–
ú”
í–
íÕ
í–
ú"–
}†ç°ddPro
°d
dPro    †åq

8

B

B

8

8

8

B"

#†ç°ddPro
°d
dPro    †åq
g
8
l
B
j
B
l
8
j
8
g
8
j
B"
j
#†ç°ddPro
°d
dPro    †åq
ö
í
†
ú
ù
ú
†
í
ù
í
ö
í
ù
ú"
ù
}†ç°ddPro
°d
dPro    †åq
Õ
8
”
B
–
B
”
8
–
8
Õ
8
–
B"
–
#†ç°ddPro
1Ñè
˝
    °ñ
°ddPro8
°öˇ–ˇ‹

JÄV
.ˇ

‡
k§
ˇøó°dONLNdˇˇ+(Security Add-on Structure†óˇˇˇˇˇˇ

J|*
Á    1}â
˜
    ˇˇˇˇˇˇˇˇ8†å    à"à"à"à"A䂱˝ˇˇˇˇˇˇ    AÑ‹´ˆ    ˇˇˇˇˇˇˇˇH†ç°ñ
°ddPro0
°ö˝eˇ¡

ì
Ìï°dONLNdˇˇ(
ïType:    °ddPro0
Ä=°dONLNdˇˇ)
    °ddPro0
°dONLNdˇˇ)'CLMP'°ddPro0
Ìï°dONLNdˇˇ(ï    Creator:    °ddPro0
°dONLNdˇˇ)4vendor specific†ó†å

J|*
Á    à"à"à"à"AΩ‚‰˝ˇˇˇˇˇˇ    A∑‹fiˆ    ˇˇˇˇˇˇˇˇH†ç†å    à"à"à"à"A‚
˝ˇˇˇˇˇˇ    AÍ‹
ˆ    ˇˇˇˇˇˇˇˇH†ç†å    à"à"à"à"A
V‚
}˝ˇˇˇˇˇˇ    A
P‹
wˆ    ˇˇˇˇˇˇˇˇH†ç†å    à"à"à"à"A
ä‚
±˝ˇˇˇˇˇˇ    A
É‹
™ˆ    ˇˇˇˇˇˇˇˇH†ç†å    à"à"à"à"A
Ω‚
‰˝ˇˇˇˇˇˇ    A
∂‹
›ˆ    ˇˇˇˇˇˇˇˇH†ç°ñ
°ddPro0
°öˇoˇ 

êç≠œàΰdONLNdˇˇ(óèInformation°ddPro0
àΰdONLNdˇˇ*        Resource°ddPro0
àΰdONLNdˇˇ*
'sinf' ID 200†ó°ñ
°ddPro0
°öˇˇ 

…çfiÿàΰdONLNdˇˇ*'User Configuration°ddPro0
àΰdONLNdˇˇ*    'UCNF' ID 200†ó°ñ
°ddPro0
°ö˛flˇ 

ˆç
–àΰdONLNdˇˇ*#Connection°ddPro0
àΰdONLNdˇˇ*
Configuration°ddPro0
àΰdONLNdˇˇ*    'CCNF' ID 200†ó°ñ
°ddPro0
°ö˛Oˇ 


\ç
zÃàΰdONLNdˇˇ*TServer Protocol°ddPro0
àΰdONLNdˇˇ*    Level°ddPro0
àΰdONLNdˇˇ*    'SRPR' ID 200†ó°ñ
°ddPro0
°ö˛ˇ 


èç
≠…àΰdONLNdˇˇ*!Client Protocol°ddPro0
àΰdONLNdˇˇ*    Level°ddPro0
àΰdONLNdˇˇ*    'CLPR' ID 200†ó°ñ
°ddPro0
°ö˝øˇ 



‡ÕàΰdONLNdˇˇ*!Client Line°ddPro0
àΰdONLNdˇˇ*    Level°ddPro0
àΰdONLNdˇˇ*    'CLLN' ID 200†ó†å

J|*
Á    à"à"à"à"1å‰óÓˇˇˇˇˇˇ    1ä‚ïÏ    ˇˇˇˇˇˇˇˇ8"å‚"ç‰"ê‚"ë‰"삆ç†å    à"à"à"à"1æ„ ˇˇˇˇˇˇ    1Ω‚…Ô    ˇˇˇˇˇˇˇˇ8    à"à"Q¡‚…Í    ˇˇˇˇˇˇˇˇX    ™U™U™U™UQΩÁ≈Ô    ˇˇˇˇˇˇˇˇX†ç†å    à"à"à"à"1Ò„˝ˇˇˇˇˇˇ    1‚¸Ô    ˇˇˇˇˇˇˇˇ8    à"à"QÙ‚¸Í    ˇˇˇˇˇˇˇˇX    ™U™U™U™UQÁ¯Ô    ˇˇˇˇˇˇˇˇX†ç†å    à"à"à"à"1
W„
cˇˇˇˇˇˇ    1
V‚
bÔ    ˇˇˇˇˇˇˇˇ8    à"à"Q
[‚
bÍ    ˇˇˇˇˇˇˇˇX    ™U™U™U™UQ
VÁ
^Ô    ˇˇˇˇˇˇˇˇX†ç†å    à"à"à"à"1
ä„
ñˇˇˇˇˇˇ    1
ä‚
ñÔ    ˇˇˇˇˇˇˇˇ8    à"à"Q
é‚
ñÍ    ˇˇˇˇˇˇˇˇX    ™U™U™U™UQ
äÁ
ëÔ    ˇˇˇˇˇˇˇˇX†ç†å    à"à"à"à"1
Ω„
…ˇˇˇˇˇˇ    1
Ω‚
…Ô    ˇˇˇˇˇˇˇˇ8    à"à"Q
¡‚
…Í    ˇˇˇˇˇˇˇˇX    ™U™U™U™UQ
ΩÁ
ƒÔ    ˇˇˇˇˇˇˇˇX†ç†å    à"à"à"à"A
I*
cˇˇˇˇˇˇ    A
˝
B$
\    ˇˇˇˇˇˇˇˇH†ç†å    à"à"à"à"1
I
Vˇˇˇˇˇˇ    1
I
U    ˇˇˇˇˇˇˇˇ8    à"à"Q
I
P    ˇˇˇˇˇˇˇˇX    ™U™U™U™UQ
N
U    ˇˇˇˇˇˇˇˇX†ç†å    à"à"à"à"A
¢*
ºˇˇˇˇˇˇ    A
˝
ú$
∂    ˇˇˇˇˇˇˇˇH†ç†å    à"à"à"à"1
§
Æˇˇˇˇˇˇ    1
¢
¨    ˇˇˇˇˇˇˇˇ8"
¢"
§"    
¢"

§"
¢†ç°ñ
°ddPro0
°ö˝e˛ò


f
èÁ°dONLNdˇˇ+Ÿ.Code°ddPro0
Á°dONLNdˇˇ*    Resource†ó°ñ
°ddPro0
°ö˝e˛


¿
ÁhÀ°dONLNdˇˇ(

¬Data°ddPro0
hÀ°dONLNdˇˇ*    Resource†ó†å

J|*
Á    à"à"à"à"1o
C∑
ãˇˇˇˇˇˇ    1j
<≤
Ñ    ˇˇˇˇˇˇˇˇ8†ç†å    à"à"à"à"1ú
ú‰
‰ˇˇˇˇˇˇ    1ó
ïfl
›    ˇˇˇˇˇˇˇˇ8†ç†å    à"à"à"à"1‹
C
$
ãˇˇˇˇˇˇ    1◊
<

Ñ    ˇˇˇˇˇˇˇˇ8†ç†å    à"à"à"à"1
B
C
ä
ãˇˇˇˇˇˇ    1
=
<
Ö
Ñ    ˇˇˇˇˇˇˇˇ8†ç†å    à"à"à"à"1
u
ú
Ω
‰ˇˇˇˇˇˇ    1
p
ï
∏
›    ˇˇˇˇˇˇˇˇ8†ç†å    à"à"à"à"1
®
C

ãˇˇˇˇˇˇ    1
£
<
Ï
Ñ    ˇˇˇˇˇˇˇˇ8†ç°d
dPro    †åqî
2ö
<ó
<ö
2ó
2î
2ó
<"ó
#†ç°ddPro
°d
dPro    †åq«
ãÕ
ï 
ïÕ
ã 
ã«
ã 
ï" 
|†ç°ddPro
°d
dPro    †åq˙
2

<˝
<

2˝
2˙
2˝
<"˝
#†ç°ddPro
°d
dPro    †åq
`
2
f
<
c
<
f
2
c
2
`
2
c
<"
c
#†ç°ddPro
°d
dPro    †åq
ì
ã
ô
ï
ñ
ï
ô
ã
ñ
ã
ì
ã
ñ
ï"
ñ
|†ç°ddPro
°d
dPro    †åq
«
2
Ã
<
…
<
Ã
2
…
2
«
2
…
<"
…
#†ç°ddPro
°ñ
°ddPro(
°öˇù˛Œ

p
@ë
É,Times
ãÉ°dONLNdˇˇ(w
BContains information°ddPro(
ãÉ°dONLNdˇˇ*about this security°ddPro(
ãÉ°dONLNdˇˇ*module.  E.g. code °ddPro(
ãÉ°dONLNdˇˇ*resource types.†ó°ñ
°ddPro(
°öˇ]˛P

ù
ö÷
ÿœ°dONLNdˇˇ+ZA code resource that°ddPro(
œ°dONLNdˇˇ*is loaded to provide°ddPro(
œ°dONLNdˇˇ*an interface for°ddPro(
œ°dONLNdˇˇ*configuring security°ddPro(
œ°dONLNdˇˇ*information°ddPro(
œ°dONLNdˇˇ*for a given user on °ddPro(
œ°dONLNdˇˇ*
the server†ó°ñ
°ddPro(
°öˇ˛Œ

›
@

ãÉ°dONLNdˇˇ(‰
BA code resource that°ddPro(
ãÉ°dONLNdˇˇ*is loaded to provide°ddPro(
ãÉ°dONLNdˇˇ*an interface for°ddPro(
ãÉ°dONLNdˇˇ*configuring security°ddPro(
ãÉ°dONLNdˇˇ*information for a°ddPro(
ãÉ°dONLNdˇˇ*connection °ddPro(
ãÉ°dONLNdˇˇ*document on the °ddPro(
ãÉ°dONLNdˇˇ*client†ó°ñ
°ddPro(
°ö˛s˛Œ


C
@
t
ãÉ°dONLNdˇˇ*/A code resource that °ddPro(
ãÉ°dONLNdˇˇ*is loaded by the °ddPro(
ãÉ°dONLNdˇˇ*server during the °ddPro(
ãÉ°dONLNdˇˇ*protocol level °ddPro(
ãÉ°dONLNdˇˇ*authentication of a °ddPro(
ãÉ°dONLNdˇˇ*user†ó°ñ
°ddPro(
°ö˛+˛P


v
ö
ß
€œ°dONLNdˇˇ+ZThis is the code°ddPro(
œ°dONLNdˇˇ*resource that is °ddPro(
œ°dONLNdˇˇ*loaded°ddPro(
œ°dONLNdˇˇ*on the client side°ddPro(
œ°dONLNdˇˇ*during protocol°ddPro(
œ°dONLNdˇˇ*level authentication†ó°ñ
°ddPro(
°ö˝„˛Œ


©
@
À
|ãÉ°dONLNdˇˇ(
∞
BThis resource is°ddPro(
ãÉ°dONLNdˇˇ*loaded on the client°ddPro(
ãÉ°dONLNdˇˇ*side for line level°ddPro(
ãÉ°dONLNdˇˇ*security devices†ó°ñ
°ddPro$
°ö˝BˇÂ

|&
    ZÌ°dONLNdˇˇ(#|+Copyright © 1992, 1993 Apple Computer, Inc.†ó†É

d
.ˇ



°dONLNdE:ZF
«(CZQThe information resource is described in the module Information Resource section.£±°dONLNdóVZb    *`Each of the code resources provides an entry point.  This is a routine which will be called when∫°dONLNd¯hZt    *YARA needs to execute a code resource.  The entry point routine and the operations it must°dONLNd
RzZÜ
j*=support are described in the Code Resource Structure section.
C¯°dONLNd
êñZ¢    *_When a code resource is loaded, it will be able to access ARA to request certain services.  ForˇˇÛ°dONLNd
®Z¥    *bexample it can have data sent to the remote machine.  These services are provided as routines that°dONLNdS∫ZΔ
¸*^can be called from a security module.  They are described in the ARA Service Routines section.
    (Ú$*Copyright © 1992, 1993 Apple Computer Inc.(Ú;
3ˇ¨dˇˇˇˇˇd

d,    Helvetica
    .ˇ+$,ARA Add-on Security Interface(,Version 1.0,Palatino
°dONLNd6ZB
å(?ZEThe following diagram is a high level view of a loaded code resource:°ddPro
†Ç°‘
††°§


    à"à"à"à""
$ı###@####˘##¸E##˙#†£

JS
Ÿ"
$ı#@##˘#¸E#˙†°††°§


"
n
#3##ü#†£

JS
Ÿ"
n
3#ü†°°d
dPro    †åq
k

r

n

k

n

r

n
"
n
˙†ç°ddPro
††°§
P

"≈
h#—##0#†£

JS
Ÿ"≈
h—#0†°°d
dPro    †åq
5˝
<˝
9
5
9
<˝
9"Â
9†ç°ddPro
Aô
i
∏H°d
dPro    †åq™
\±
hÆ
h±
\Æ
\™
\Æ
h"ÆÈs†ç°ddPro
1¯‚

a81â\
«Î8ˇˇˇˇˇˇ    1ÅT
ø„    ˇˇˇˇˇˇˇˇ8°ñ
°ddPro
0
°öˇèˇ€

êYµï
.ˇ

è
Ω
≈
˙„
°dONLNdˇˇ+
[Apple°ddPro
0
„
°dONLNdˇˇ*Remote°ddPro
0
„
°dONLNdˇˇ*Access†óˇˇˇˇˇˇ

JS
Ÿ    Aë
a
∞    ˇˇˇˇˇˇˇˇH°ñ
°ddPro8
°öˇfiˇ‰

JSf
KÙ°dONLNdˇˇ(UTApple Remote Access°ddPro8
Ù°dONLNdˇˇ*Add-on Security Code Resources†óˇˇˇˇˇˇ

JS
Ÿ    1⁄

Y    ˇˇˇˇˇˇˇˇ8°ñ
°ddPro$
°ö˛2˛∂


Δ
[
Ÿ    ™°dONLNdˇˇ(
Õ
^,Copyright © 1992, 1993 Apple Computer, Inc.†ó°ñ
°ddPro
0
°öˇÅ˛°

ù
m¬
º
`fi°dONLNdˇˇ(¶
p    Security°ddPro
0
`fi°dONLNdˇˇ*Code °ddPro
0
`fi°dONLNdˇˇ*Resource†ó°ñ
°ddPro0
°öˇB˛£

‘
l
í≈J°dONLNdˇˇ(fi
nTypes:°ddPro$
,
Courier    ≈J*

°ddPro$
≈J°dONLNdˇˇ*
    °ddPro
$

n6°dONLNdˇˇ) Server Protocol-Level°ddPro
$
≈J°dONLNdˇˇ(˘
n
    °ddPro
$
n6°dONLNdˇˇ) Client Protocol-Level°ddPro
$
≈J°dONLNdˇˇ(

n
    °ddPro
$
n6°dONLNdˇˇ) User Configuration°ddPro$
Ì)U
°ddPro
$

≈J(

n
°ddPro
$
≈J°dONLNdˇˇ*    
    °ddPro
$
n6°dONLNdˇˇ) Client Line-Level°ddPro
$
≈J°dONLNdˇˇ(

n
    °ddPro
$
n6°dONLNdˇˇ) Connection Configuration°ddPro$
≈J(
%
n
°ddPro0
≈J*
°ddPro0
≈J*
°ddPro0
≈J°dONLNdˇˇ*Supported Actions:°ddPro$
    ≈J*    
°ddPro
$

≈J°dONLNdˇˇ*    
    °ddPro
$
n6°dONLNdˇˇ) kSecurityStartup°ddPro
$
≈J°dONLNdˇˇ(
b
n
    °ddPro
$
n6°dONLNdˇˇ) kSecurityShutdown°ddPro
$
≈J°dONLNdˇˇ(
k
n
    °ddPro
$
n6°dONLNdˇˇ) kSecurityBegin°ddPro
$
≈J°dONLNdˇˇ(
t
n
    °ddPro
$
n6°dONLNdˇˇ) kSecurityEnd°ddPro
$
≈J°dONLNdˇˇ(
|
n
    °ddPro
$
n6°dONLNdˇˇ) kSecurityDataAvaialble°ddPro
$
≈J°dONLNdˇˇ(
Ö
n
    °ddPro
$
n6°dONLNdˇˇ) kSecurityAbort°ddPro
$
≈J°dONLNdˇˇ(
é
n
    °ddPro
$
n6°dONLNdˇˇ) kSecurityTickleAction†ó°ñ
°ddPro
0
°öˇˇG

ˆ€

Pd,°dONLNdˇˇ(ˇfiARA Service Routines†ó°d
dPro    †å

JS
Ÿq¢
T©
`¶
`©
T¶
T¢
T¶
`"¶·s†ç°ddPro
°ñ
°ddPro
$
°ö˛·ˇ”


+`
©‹    R·°dONLNdˇˇ(
3cARARead°ddPro
$
R·°dONLNdˇˇ*        ARAWrite°ddPro
$
R·°dONLNdˇˇ*    ARALogMessage°ddPro
$
R·°dONLNdˇˇ*    ARACallBackAt°ddPro
$
R·°dONLNdˇˇ*    ARAAllowUser°ddPro
$
R·°dONLNdˇˇ*ARADontAllowUser°ddPro
$
R·°dONLNdˇˇ*    ARAReadSecurityData°ddPro
$
R·°dONLNdˇˇ*    ARAReadLockSecurityData°ddPro
$
R·°dONLNdˇˇ*    ARAWriteSecurityData°ddPro
$
R·°dONLNdˇˇ*    ARAUnlockSecurityData°ddPro
$
R·°dONLNdˇˇ*ARAGetUserInfo°ddPro
$
R·°dONLNdˇˇ*    ARATickleMe°ddPro
$
R·°dONLNdˇˇ*    ARACompleteOperation†ó††°§
P

"Ω
`#—##0#†£

JS
Ÿ"Ω
`—#0†°°d
dPro    †åqÊ
-Ú
4Ú
1Ê
-Ê
1Ê
4Ú
1"›
1    †ç°ddPro
††°§
P

"
Ì###@####˘##¸E##˙#†£

JS
Ÿ"
Ì#@##˘#¸E#˙†°††°§
P

"
f˛#3##ü#†£

JS
Ÿ"
f˛3#ü†°°d
dPro    †åq
c˛
j


f˛
c


f


j


f˛"
f
˙†ç°ddPro
†É

d.ˇ



(Ú$*Copyright © 1992, 1993 Apple Computer Inc.(Ú;
4ˇÆdˇˇˇˇˇd

d,    Helvetica
    .ˇ+$,ARA Add-on Security Interface(,Version 1.0,Palatino°dONLNdX6hfl(d6Security Module Structure h4h/
⁄
°dONLNd}Zâ    +$"`A security module is built by creating a Macintosh file that has a 'CLMP' type.  This is used by
?°°dONLNd{èZõ    *]ARA to identify the file as a security module.  The module has to be placed in the Extensions
ô;°dONLNdŸ°Z≠    *]folder for ARA to find it.  You can do this by dragging it on top of your system folder after3ˆ°dONLNd
7≥Zø    *Yinstalling ARA.  The module's creator is defined by you.  You must request a creator from°dONLNd
ë≈Z—˙*"Developer Technical Support (DTS).
Ç°dONLNd
¥·ZÌ    *aAdditionally the file must contain at least a 'sinf' resource, and a number of code resources for°dONLNdÛZˇ
˛*_performing various operations.  The 'sinf' resource and the code resources are described below.;N°dONLNdv
Z
    *ZCurrently there are five types of code resources that ARA supports.  They are described in°dONLNd—
!Z
-i*subK¿°dONLNd‘
!j
-∞)-sections below.°dONLNdÊ
=Z
I
–(
FZSCode resources must have the appropriate type, and their resource ID should be 200.
    (Ú$*Copyright © 1992, 1993 Apple Computer Inc.(Ú;
5ˇbdˇˇˇˇˇd

d,    Helvetica
    .ˇ+$,ARA Add-on Security Interface(,Version 1.0°dONLNd<HJ
>(FH+Module Information Resource ('sinf' ID 200) IFI/,Palatino
ïú°dONLNd,ZZf    +aYour module must have a 'sinf' resource with a resource ID of 200.  The 'sinf' resource describes°dONLNdélZxÚ*#what the module's capabilities are.
ã°dONLNd≤àZî    *bIn your resource definition file, you should create a 'sinf' resource, and fill in the appropriate
f\°dONLNd
öZ¶    *bfields.  The template for the resource is defined in a file named "SecurityTypes.r".  This file is°dONLNd
x¨Z∏
∏*Rfound on the developer disk.  The following is the template for a 'sinf' resource:,
Courier°dONLNd
À√gœ©+type 'sinf'°dONLNd
◊√Æœ¥)G
{°dONLNd
›√
%œ
˜)w#/* security information resource */°dONLNdŸ~ÂÆ(‚~unsigned°dONLNdŸΔˆ)Hlongint;°dONLNdŸ
%Â)_'/* fflags contains info about module */°dONLNd@Ô~˚®(¯~literal°dONLNdIÔΔ˚ˆ)Hlongint;°dONLNdSÔ
%˚
Ò)_"/* fsignature identifies module */°dONLNdx˙~
Æ(
~unsigned°dONLNdÅ˙Δ
ˆ)Hlongint;°dONLNdã˙
%

y)_/* fversion */°dONLNdú
~
¥(
~    unsigned °dONLNd¶
Δ
ˆ)Hlongint;°dONLNd∞

%

ë)_/* fmin_version */°dONLNd≈
~
Æ(
~unsigned°dONLNdŒ
Δ
ˆ)Hlongint;°dONLNdÿ

%

ë)_/* fmax_version */°dONLNdÌ
&~
2Æ(
/~unsigned°dONLNdˆ
&Δ
2ˆ)Hlongint;°dONLNd
&
%
2
ë)_/* fserver_data */°dONLNd
1~
=Æ(
:~unsigned°dONLNd
1Δ
=ˆ)Hlongint;°dONLNd(
1
%
=
ë)_/* fclient_data */°dONLNd=
G~
S“(
P~pstring[ 31 ];°dONLNdO
G
%
S
ã)ß/* module name */°dONLNda
]g
is(
fg};º√°dONLNdd
xZ
Ñ    (
ÅZdThe first longint is a set of flags that define what the capabilities of the module are.  The values蟰dONLNd…
äZ
ñ    *afor the flags are defined in "SecurityResInfo.h", found on the developer disk.  The values should°dONLNd+
úZ
®
]*:be a combination of the following using the "OR" operator:°dONLNdf
æ~
 Â+$"kSecurityHasLineLevel
ƒƒ°dONLNd|
º
)
»
‘(
≈
)%Use this flag if your module is to be
t&°dONLNd¢
»
)
‘
c*used for lineπå°dONLNdØ
»
c
‘
‘):-level authentication of a
ò‡°dONLNd 
‘
)
‡
‘(
›
)%user.  This flag causes the module to{d°dONLNd
‡
)
Ï
‘**be displayed on the client side.  It let's0ï°dONLNd
Ï
)
¯
‘*!the user select this module for a䯰dONLNd=
¯
)
‘*$connection document, used to connectt‡°dONLNdb
)
‘*"to a port with a physical security°dONLNdÖ
)
H*device.°dONLNdé&~2ˆ(/~kSecurityHasProtocolLevel    äê°dONLNd©$
)0
‘(-
)This flag indicates the module7Í°dONLNd»0
)<
‘*'provides protocol level authentication.Sˆ°dONLNdÒ<
)H
‘*&It can be used in combination with the-\ °dONLNdH
)T
‘*kSecurityHasServerSide and—0°dONLNd3T
)`
‘*kSecurityHasClientSide flags toLÏ°dONLNdS`
)l
‘*#indicate if the module supports the°dONLNdwl
)x
≤*"client side, server side, or both.°dONLNdõÇ~éË(ã~kSecurityHasServerSide6õ°dONLNd≥Ä
)å
‘(â
)"This flag is set for a module that]ȡdONLNd֌
)ò
‘*"provides the code resources needed
E °dONLNd˘ò
)§
‘*%for the server side.  Any module that
    {°dONLNd§
)∞
‘*%has code to be executed on the server‘,°dONLNdE∞
)º
‘*$should set this flag, including user°dONLNdjº
)»
g*configuration.
    (Ú$*Copyright © 1992, 1993 Apple Computer Inc.(Ú;
6ˇBdˇˇˇˇˇd

d,    Helvetica
    .ˇ+$,ARA Add-on Security Interface(,Version 1.0,Palatino
°dONLNd@~LÁ(I~kSecurityHasClientSide6õ°dONLNd>
)J
‘(G
)"This flag is set for a module that¶ °dONLNd;J
)V
‘*"provides code resources needed for
f≤°dONLNd^V
)b
‘*%the client side.  Any module that has≠°dONLNdÑb
)n
‘*!code to be executed on the client°dONLNd¶n
)z
~*should set this flag.°dONLNdΩÑ~êÏ(ç~kSecurityHasUserConfig •°dONLNd’Ç
)é
ª(ã
) This flag is used for a protocol!fi°dONLNdıÇ
ºé
‘)ì-levelM°dONLNd¸é
)ö
‘(ó
)#module that has a code resource for
}0°dONLNd
 ö
)¶
‘*%configuring users on the server.  Has°dONLNd
F¶
)≤
t*'UCNF' resource.°dONLNd
Xº~»

(≈~kSecurityHasConnectionConfig∂∫°dONLNd
v∫
)Δ
º(√
)This flag is used for a line!‹°dONLNd
í∫
ΩΔ
’)î-levelM°dONLNd
ôΔ
)“
‘(œ
)#module that has a code resource forI@°dONLNd
Ω“
)fi
‘*$security configuration on the client°dONLNd
‚fi
)Í
®*side.  Has a 'CCNF' resource.°dONLNd
Ù~
Î(˝~kSecurityHasUserDialog°dONLNdÚ
)˛
{(˚
)Don't use this flag.°dONLNd.

~

    (
~kSecurityHasConnectionDialog°dONLNdL

)

{(

)Don't use this flag.÷D°dONLNdc
2Z
>    (
;Z`The second longint is the signature of the module.  This value uniquely identifies your security
y°dONLNdƒ
DZ
P    *Zmodule.  You should reserve a value through Apple Developer Technical Support (DTS).  ThisπS°dONLNd
VZ
b    *cvalue should be the same as your file's creator, but it can be different.  When they are different,
6,°dONLNdÉ
hZ
t
{*@ARA uses the value defined in the 'sinf' resource.  For protocol§°dONLNd√
h
|
t
(
q
| -level modules this signature is°dONLNd‰
zZ
Ü
W(
ÉZ9used to associate a client module with the server module.π^°dONLNd
ñZ
¢    *^The next three longints are version numbers and are only used for protocol level modules.  TheÒ6°dONLNd}
®Z
¥    *[first field is "fversion" and defines the module's version.  The field after "fversion" areˇˇÈ°dONLNdŸ
∫Z
Δ
5*1"fmin_version", and "fmax_version".  For protocol)°dONLNd

∫
6
Δ    )‹1-level authentication, they are used for checking
–¿°dONLNd<
ÃZ
ÿ    (
’Z^the client module's compatibility with the server's.  The client's "fversion" must be a number°dONLNdõ
fiZ
Í
y*>between the server module's "fmin_version" and "fmax_version".°dONLNd€
˙Z*bThe next two longints, "fserver_data" and "fclient_data", are not used, and should be set to zero.€°dONLNd>Z"    *dThe last field is a Pascal string that is your module's name.  This name is used in dialog boxes and°dONLNd£(Z4
*)anywhere your modul'es name is displayed.
    (Ú$*Copyright © 1992, 1993 Apple Computer Inc.(Ú;
7ˇÏdˇˇˇˇˇd

d,    Helvetica
    .ˇ+$,ARA Add-on Security Interface(,Version 1.0°dONLNd<HJÿ(FHCode Resource Structure IFI/,Palatino
°dONLNdZZf
Ñ+DThe following sub-sections describe the structure of code resources.
°dONLNd]vHÑΩ(ÄHMySecurityProcEntry

ëÇ°dONLNdqîZ†    +ZEvery code resource must provide a routine named "MySecurityProcEntry".  This is the entry≈É°dONLNdöZ≤    *bpoint to the code resource.  ARA calls it through the Security Interface.  It should be defined as°dONLNd
/∏Zƒ}*follows:,
Courier°dONLNd
8œg€©+pascal long°dONLNd
EœΔ€
û)_$MySecurityProcEntry( SecurityActions°dONLNd
kœ
Œ€
¯(ÿ
ŒAction,°dONLNd
|⁄
>Ê
™(„
> SecurityReference°dONLNd
ê⁄
ŒÊ)êMyReference,°dONLNd
¶Â
>Ò
\(Ó
> long°dONLNd
∞Â
ŒÒ)êLongParam )Qæ°dONLNd
º
Z
    (
    Z`ARA sends actions to your code resources to request it to perform a service.  You should process
¥«°dONLNd
Z
    *^the actions and return control to ARA as quickly as possible.  Actions are defined in the fileΩÊ°dONLNd|
$Z
0    *eSecurityPublic.h.  The "Actions" section describes actions in detail.  The following is a list of the°dONLNd‚
6Z
B{*actions:°dONLNdÎ
Ng
Z«+kSecurityStartup°dONLNd¸
Yg
eÕ*kSecurityShutdown°dONLNd
dg
pª*kSecurityBegin°dONLNd
og
{Ø*kSecurityEnd°dONLNd*
zg
ÜÒ*kSecurityDataAvailable,°dONLNdB
Ög
ëª*kSecurityAbort°dONLNdQ
êg
úÂ*kSecurityTickleAction4”°dONLNdg
∂Z
¬    (
øZaMyReference is a unique value that defines an instance of the code resource.  It is used when you°dONLNd…
»Z
‘
ô*Jcall any of the ARA Service Routines.  It uniquely identifies your thread.„4°dONLNd
‰Z
    *_LongParam is used to pass additional information for an action.  Currently it is only used with°dONLNdt
ˆZæ*kSecurityTickleAction.ß°dONLNdãZ    *aYour entry routine should process the action as soon as possible.  It should not stay go into any
¬°dONLNdÌ$Z0    *^loops.  It can post asynchronous calls to ARA and other Toolbox routines, but it should return„$°dONLNdL6ZB    *Lcontrol back to ARA quickly.  YOU MUST RETURN CONTROL BACK TO ARA AS SOON AS°dONLNdôHZTä*    POSSIBLE.0«°dONLNd£dZp    *PYour routine's return value is a result code ARA examines for possible errors inx°dONLNdÙvZÇ    *Q"MySecurityProcEntry".  The possible result codes are "SecurityErrors" defined in°dONLNdFàZî
ü*L"SecurityPublic.h".  Return "kSecurityNoErr" if  your routine is successful.
°dONLNdì§H≤Ø(ÆHSecurityInterface.o

˘°dONLNd߬ZŒ    +a"SecurityInterface.o" is the glue file that provides the ARA Service Routines.  It must be linkedÃ¥°dONLNd    ‘Z‡    *^with each code resource.  When linking a code resource, you must have "SecurityInterface.o" as
    (Ú$*Copyright © 1992, 1993 Apple Computer Inc.(Ú;
8ˇúdˇˇˇˇˇd

d,    Helvetica
    .ˇ+$,ARA Add-on Security Interface(,Version 1.0,Palatino
@À°dONLNd6ZB    (?Zhthe first file in the linker's object file list.  The MPW linker does not shuffle code.  The entry point°dONLNdiHZT
•*Kto "SecurityInterface.o" must become the entry point to your code resource.
∂°dONLNdµdZp
6*-MPW linker uses the -m option to perform code‰∞°dONLNd‚d
6p    )‹,-flow analysis and remove any dead code.  To
TΔ°dONLNd
vZÇ    (Z[keep your executable code from being stripped, you must provide the following option in the°dONLNd
kàZî∏*linker command line:,
Courier°dONLNd
Ćg¨
+-m SECURITYINTERFACEENTRYPROC
°dONLNd
ûªH…∏(≈HCompletion Routine

Ÿ°dONLNd
±ŸZ    +\Most of the ARA Service Routines are asynchronous.  After an asynch ARA routine finishes, it`°dONLNdÎZ˜    *_informs you code resource by calling a completion routine.  Your completion routine should have°dONLNdn˝Z
    À*the following declaration:°dONLNdâ
g
 ©+pascal void°dONLNdñ
Δ
 
ò)_#MyCompletionProc( SecurityReference°dONLNdª

∂
 
˛)MyReference,°dONLNd–

%
+
C(
(
%  int°dONLNd⁄

∂
+
¯)ëResultCode,°dONLNdÓ
*
%
6
I(
3
%  void°dONLNd˘
*
∂
6
Ú)ë
* DataPtr,°dONLNd
5
%
A
C(
>
%  int°dONLNd
5
∂
A
Ï)ë    DataSize,°dONLNd(
@
%
L
I(
I
%  long°dONLNd3
@
∂
L)ëCompletionParam )
y°dONLNdE
[Z
g    (
dZZYou pass a pointer to your completion routine as one of the parameters to asynchronous ARA°dONLNd†
mZ
y•*Service Routines.íÇ°dONLNd≤
âZ
ï    *YMyReference should is the same value passed to "MySecurityProcEntry".  It identifies your°dONLNd
õZ
ßÄ*    instance.(t°dONLNd
∑Z
√    *`ResultCode is the result of the asynchronous ARA Service you had requested.  It will be non zeroÒ⁄°dONLNdw
…Z
’    *bif the operation failed.  It will contain one of the values in ARAErr defined in SecurityPublic.h.ðdONLNd€
€Z
Á    *ZYou should check its value at the start of your completion routine before you do any other°dONLNd6
ÌZ
˘
∞*Mprocessing.  If a read or write times out, the ResultCode will be ARATimeout.ò”°dONLNdÑ    Z    *aDataPtr is the pointer you passed to the asynch ARA Service Routine.  E.g. this will point to the°dONLNdÊZ'√*data read by ARARead.°dONLNd¸7ZC¥*DataSize will be the ∞ °dONLNd7¥CŒ)ZactualR@°dONLNd7œC
˙)C size of processed data.  E.g. the number of bytes read by ARARead.‘°dONLNd[SZ_    (\Z_CompletionParam is an additional long you provide.  Its value will be the same value you passed›£°dONLNdªeZq    *`to the asynch ARA Service Routine.  You can use it as a state indicator.  E.g. you can define an    •°dONLNdwZÉ    *aenumeration containing the set of all your states.  When you call an asynch ARA routine, pass theu°dONLNd~âZï    *^state you want to be in when the call is done.  E.g. pass "kFinished1stRead" to ARARead.  When7ñ°dONLNd›õZß    *Yyour completion routine gets called with CompletionParam equal to "kFinished1stRead", theó°dONLNd7≠Zπ    *^ARARead has finished and you can go to the next state.  See the sample module on the developer°dONLNdñøZÀ—*disk for an example of this.
    (Ú$*Copyright © 1992, 1993 Apple Computer Inc.(Ú;
9ˇ
dˇˇˇˇˇd

d,    Helvetica
    .ˇ+$,ARA Add-on Security Interface(,Version 1.0,Palatino

ºŒ°dONLNd6ZB    (?ZXYou should not call any Memory Manager routines, or any routines that result in a MemoryÈh°dONLNdYHZT    *ZManager call from a completion routine.  If you need to call these types of routines, call°dONLNd¥ZZf
X*7ARATickleMe and handle it in the kSecurityTickleAction.
°dONLNdÏvHÑ
(ÄHRuntime Environment (A5 World)

bH°dONLNd
îZ†    +XAn A5 World is setup for your code resource by ARA.  You don't need to be concerned with´K°dONLNd
d¶Z≤    *`initializing or setting up the A5 world in the code resource.  ARA sets up the A5 world prior to
ˇP°dONLNd
≈∏Zƒ    *\executing any of the code resource (entry routine, and completion routines).  Since the code£ı°dONLNd" Z÷    *_resource has an A5 world, it you can have static (global) data and use the data the same way as°dONLNdÇ‹ZËõ*an application.ê°dONLNdí¯Z
    *aDuring the execution of your code resource, the resource fork of the security module is open, andò\°dONLNdÙ

Z
    *bit is put on top of the resource forks stack.  The file is opened in read only mode, so you should¯™°dONLNdW
Z
(    *`not attempt to write any data to the module's resource fork.  A better way of storing data is tog#°dONLNd∏
.Z
:    *cstore it in a separate preference file, which will not be deleted when you update a user's security°dONLNd
@Z
L~*module.æI°dONLNd$
\Z
h    *[You can make calls to Mac Toolbox routines.  Whenever possible you should call asynchronousÛ‡°dONLNdÄ
nZ
z    *]routines, so you can return control to ARA.  Furthermore, you should not go into any loops or°dONLNdfi
ÄZ
å
I*5call SystemTask as a way of returning control to ARA.
°dONLNd
úH
™¬(
¶HARA Service Routines

°dONLNd)
∫Z
Δ    +[ARA provides a number of services accessible through ARA Service Routines.  The header file
P‰°dONLNdÖ
ÃZ
ÿ    *_"SecurityInterface.h" has the declarations for these routines.   To use them you must link with°dONLNdÂ
fiZ
Í∂*"SecurityInterface.o".°dONLNd¸
˙Z
Ä*DThe ARA Service Routines are described in detail in a later section.
    (Ú$*Copyright © 1992, 1993 Apple Computer Inc.(Ú610ˇ¨dˇˇˇˇˇd

d,    Helvetica
    .ˇ+$,ARA Add-on Security Interface(,Version 1.0°dONLNd<HJ
A(FH)User Configuration (UCNF Resource ID 200) IFI/,Palatino
»…°dONLNd*ZZf    +ZThis code resource is executed when a user window is open on the ARA server admin, and theìe°dONLNdÖlZx    *^security module's configuration button is selected.  It is used for configuring protocol-level’D°dONLNd‰~Zä    *^security information on a per-user basis.  The code resource should display a modal dialog boxfi¯°dONLNd
CêZú    *Rand get any needed information.  It can store 150 bytes of data for each user (see°dONLNd
ñ¢ZÆ
F*/ARAWriteSecurityData, and ARAReadSecurityData).
ân°dONLNd
ΔæZ     *^On kSecurityBegin you should start your processing, e.g. request to read the existing security
Xt°dONLNd%–Z‹    *Xdata (ARAReadLockSecurityData), or to get the user's name (ARAGetUserInfo).  When you've^˙°dONLNd~‚ZÓ    *^obtained this information, you can call ARATickleMe to put up the modal dialog box (it must beˇˇ˘¥°dONLNd›ÙZ
    *ca modal dialog box).  You must display the user's name at the top of this dialog box.  The user cand‹°dONLNdA
Z
    *cthen input/modify the information and either save or cancel.  If the user selects to save the data,~´°dONLNd•
Z
$    *_you must write it out by calling ARAWriteSecurityData.  This information will then be available°dONLNd
*Z
6
O*8to the server-side protocol-level authentication module.°dONLNd>
FZ
R
©*GThe following ARA Service Routines can be used by a UCNF code resource:,
Courier°dONLNdÜ
^g
jµ+ARALogMessage°dONLNdî
ig
uŸ*ARAReadSecurityData°dONLNd®
tg
ÄÒ*ARAReadLockSecurityData°dONLNd¿
g
ãÂ*ARAUnlockSecurityData°dONLNd÷
äg
ñfl*ARAWriteSecurityData°dONLNdÎ
ïg
°ª*ARAGetUserInfo°dONLNd˙
†g
¨©*ARATickleMe°dONLNd
´g
∑fl*ARACompleteOperation
    (Ú$*Copyright © 1992, 1993 Apple Computer Inc.(Ú611ˇ2dˇˇˇˇˇd

d,    Helvetica
    .ˇ+$,ARA Add-on Security Interface(,Version 1.0°dONLNd<HJi(FHClient”@°dONLNd<iJ
E)!%-side Protocol (CLPR Resource ID 200) IFI/,Palatino
íÆ°dONLNd,ZZf    (cZXThis code resource is executed on the ARA client for protocol-level authentication.  The(j°dONLNdÖlZx    *[corresponding server-side protocol-level module is also executed on the server, and the two°dONLNd·~Zä
*)module's can communicate with each other.ÃD°dONLNd
öZ¶    *^The client module's state should be driven by the server, and when the authentication has been[F°dONLNd
j¨Z∏    *Wcompleted, both sides should call ARAAllowUser/ARADontAllowUser, so ARA can progress to°dONLNd
¬æZ ñ*the next state.£Æ°dONLNd
“⁄ZÊ    *OA CLPR module can pass a maximum of 500 bytes of data to ARAWrite/ARARead.  The”Ú°dONLNd"ÏZ¯    *XARAWrite and ARARead will communicate with the server-side protocol (i.e. ARARead on the°dONLNd{˛Z


O*9client side will read data written by the server module).
°dONLNdµ
Z
&    *\On kSecurityBegin you should start your state machine, getting information from the user and€˙°dONLNd
,Z
8    *\sending it to the server module.  The server module should inform the client module when theí°dONLNdo
>Z
J    *Puser is authenticated or rejected, at which time it should call ARAAllowUser, or°dONLNd¿
PZ
\π*ARADontAllowUser.°dONLNd“
lZ
x
¶*GThe following ARA Service Routines can be used by a CLPR code resource:,
Courier°dONLNd
Ég
èë+ARARead°dONLNd"
ég
öó*ARAWrite°dONLNd+
ôg
•µ*ARALogMessage°dONLNd9
§g
∞Ø*ARAAllowUser°dONLNdF
Øg
ª«*ARADontAllowUser°dONLNdW
∫g
Δ©*ARATickleMe°dONLNdc
≈g
—fl*ARACompleteOperation
    (Ú$*Copyright © 1992, 1993 Apple Computer Inc.(Ú612ˇ    îdˇˇˇˇˇd

d,    Helvetica
    .ˇ+$,ARA Add-on Security Interface(,Version 1.0°dONLNd<HJm(FHServerŸ¿°dONLNd<mJ
J)%%-side Protocol (SRPR Resource ID 200) IFI/,Palatino

7®°dONLNd,ZZf    (cZ^This code resource is executed on the server to authenticate a user after the ARA protocol has
“°dONLNdãlZx    *[been established.  It can communicated with the corresponding client authentication module.°dONLNdË~Zä
**ARA loads the client module automatically.∏9°dONLNd
öZ¶    *^This code resource should get the user information from the client module and determine if the
HL°dONLNd
r¨Z∏    *^user should be allowed in.  Once a user has been authenticated or rejected, this code resource
ÿŒ°dONLNd
—æZ     *Wshould inform the client side, and then call ARAAllowUser/ARADontAllowUser.  The client°dONLNd)–Z‹
ã*=code resource should also call ARAAllowUser/ARADontAllowUser.ÔG°dONLNdgÏZ¯    *XA SRPR code resource can write and read a maximum of 500 bytes of data using ARAWrite or°dONLNd¿˛Z


I*3ARARead.  The data is exchanged with client module.ï°dONLNdÙ
Z
&    *HThis code resource can use ARAReadLockSecurityData, ARAReadSecurityData,âÊ°dONLNd=
,Z
8    *UARAWriteSecurityData, and ARAUnlockSecurityData to access and modify the 150 bytes of
k°dONLNdì
>Z
J    *bsecurity data associated with each user.  Each security module can have 150 bytes of data for each°dONLNdˆ
PZ
\o*user.°dONLNd¸
lZ
x
§*GThe following ARA Service Routines can be used by a SRPR code resource:,
Courier°dONLNdD
Ég
èë+ARARead°dONLNdL
ég
öó*ARAWrite°dONLNdU
ôg
•µ*ARALogMessage°dONLNdc
§g
∞µ*ARACallBackAt°dONLNdq
Øg
ªØ*ARAAllowUser°dONLNd~
∫g
Δ«*ARADontAllowUser°dONLNdè
≈g
—Ÿ*ARAReadSecurityData°dONLNd£
–g
‹Ò*ARAReadLockSecurityData°dONLNdª
€g
ÁÂ*ARAUnlockSecurityData°dONLNd—
Êg
Úfl*ARAWriteSecurityData°dONLNdÊ
Òg
˝ª*ARAGetUserInfo°dONLNdı
¸g”*ARAGetMySessionRef°dONLNdg©*ARATickleMe°dONLNdgfl*ARACompleteOperation
    (Ú$*Copyright © 1992, 1993 Apple Computer Inc.(Ú613ˇdˇˇˇˇˇd

d,    Helvetica
    .ˇ+$,ARA Add-on Security Interface(,Version 1.0°dONLNd<HJ
i(FH/Connection Configuration (CCNF Resource ID 200) IFI/,Palatino

2†°dONLNd0ZZf    +]A Connection Configuration code resource is executed on the client side when the user selects{˘°dONLNdélZx    *b"Configuration" button on the client in a connection document's security option.  It can store 150°dONLNdÒ~Zä
ê*Hbytes of data in a connection document for a line-level security device.ч°dONLNd
:öZ¶    *`It should display a modal dialog and get any information relevant to connections with line-level£P°dONLNd
õ¨Z∏    *Dsecurity.  You can use ARAReadLockSecurityData, ARAReadSecurityData,°dONLNd
‡æZ 
˜*WARAWriteSecurityData, and ARAUnlockSecurityData to access and modify the security data.πD°dONLNd8⁄ZÊ    *^On kSecurityBegin you should get the existing security data.  Once you have obtained the data,Û°dONLNdóÏZ¯    *ayou should display a dialog box, and allow the user to modify it.  When the user is done, you can°dONLNd˘˛Z


ò*Gwrite the security data if it was modified, using ARAWriteSecurityData.°dONLNdA
Z
&
®*GThe following ARA Service Routines can be used by a CCNF code resource:,
Courier°dONLNdâ
1g
=Ÿ+ARAReadSecurityData°dONLNdù
<g
HÒ*ARAReadLockSecurityData°dONLNdµ
Gg
SÂ*ARAUnlockSecurityData°dONLNdÀ
Rg
^fl*ARAWriteSecurityData°dONLNd‡
]g
i©*ARATickleMe°dONLNdÏ
hg
tfl*ARACompleteOperation
    (Ú$*Copyright © 1992, 1993 Apple Computer Inc.(Ú614ˇ    Ídˇˇˇˇˇd

d,    Helvetica
    .ˇ+$,ARA Add-on Security Interface(,Version 1.0°dONLNd<HJ
L(FH-Client Side Line-level (CLLN Resource ID 200) IFI/,Palatino
å°dONLNd.ZZf    +dA client-side line-level code resource is executed after a physical connection has been established,
y‚°dONLNdìlZx*Zusing a connection document configured with security.  It should communicate with the line°⁄°dONLNdÌlx    (u
-°dONLNdÓ~Zä
õ(áZIlevel device, prompting the user for any information the device requires.p@°dONLNd
8öZ¶    *XA CLLN code resource can use the ARARead and ARAWrite to communicate with the line-levelÔê°dONLNd
ë¨Z∏    *`device on the server.  The data being read or written is sent over the physical line without any
n°dONLNd
ÚæZ     *bpacketization.  Your code resource gets control of the line after a connection is established, but°dONLNdU–Z‹
ï*Fbefore your authentication device allows connection to the ARA server.Sh°dONLNdúÏZ¯    *_On kSecurityBegin you should start the communication process with the server line-level device.ó°dONLNd˝˛Z

    *_You can display a dialog box to obtain information from the user.  Once the physical device hasC®°dONLNd]
Z
    *Pauthenticated or rejected the user the code resource should call ARAAllowUser or°dONLNdÆ
"Z
.
_*9ARADontAllowUser to let ARA transition to the next state.:Ç°dONLNdË
>Z
J    *XYou can use ARAReadSecurityData to access the 150 bytes of data stored in the connection
À©°dONLNdA
PZ
\    *[document.  You can not modify this information during authentication.  The security data isê°dONLNdù
bZ
n    *astored in an alias to a remote server as well as the original connection document, so you can get°dONLNdˇ
tZ
Ä
¢*Nthe data even if the connection is initiated from an alias to a remote server.°dONLNdN
êZ
ú
á*@A CLLN code resource can use the following ARA Service Routines:,
Courier°dONLNdè
ßg
≥ë+ARARead°dONLNdó
≤g
æó*ARAWrite°dONLNd†
Ωg
…Ø*ARAAllowUser°dONLNd≠
»g
‘«*ARADontAllowUser°dONLNdæ
”g
flŸ*ARAReadSecurityData°dONLNd“
fig
Í©*ARATickleMe°dONLNdfi
Èg
ıfl*ARACompleteOperation
    (Ú$*Copyright © 1992, 1993 Apple Computer Inc.(Ú615ˇ˙dˇˇˇˇˇd

d,    Helvetica
    .ˇ+$,ARA Add-on Security Interface(,Version 1.0,Palatino°dONLNdB6Rf(N6Actions R4R/
$¯°dONLNdgZs    +$"_Actions are one of the parameters passed to your code resource's entry routine.  ARA sends them°dONLNdhyZÖ
 *-to request a service from your code resource.hí°dONLNdóïZ°    *^All actions are sent during main thread time, so you can allocate memory and make calls to Mac
°dONLNdˆßZ≥    *\Toolbox routines.  The code resource's A5 world is setup prior to calling your routine.  The°dONLNd
SπZ≈
ì*Gresource fork of your module is open and on top of the resources stack.ã®°dONLNd
õ’Z·    *XYou should process actions as quickly as possible.  You should not go into loops and use°dONLNd
ÙÁZÛ
d*;SystemTask calls as a way of returning control back to ARA.
°dONLNd0˘H
®(
HkSecurityStartup 
F
/

AP°dONLNdA
Z
#    +^kSecurityStartup is sent immediately after your code resource is loaded.  You can allocate any"Z°dONLNd†
)Z
5    *_needed memory during the processing of this action, but you should not make any calls to any ofÒ,°dONLNd
;Z
G    *[the ARA Service Routines.  Once processed, you should return kSecurityNoErr.  Generally you°dONLNd\
MZ
Y
8*2should use kSecurityBegin to start any processing.
°dONLNdè
_H
m∑(
iHkSecurityShutdown 
lF
l/
;D°dONLNd°
}Z
â    +ZkSecurityShutdown is the last action sent prior to unloading your code resource.  The code
G*°dONLNd¸
èZ
õ    *^resource will not be called any more after this action.  You can release any allocated memory.ÙÄ°dONLNd\
°Z
≠    *ZMake sure you have cleaned everything up before returning.  You can not use any of the ARA°dONLNd∑
≥Z
ø
!**Service Routines during kSecurityShutdown.
°dONLNd‚
≈H
ӟ(
œHkSecurityBegin 
“F
“/
 §°dONLNdÒ
„Z
Ô    +akSecurityBegin is sent to request your code resource to perform its operation.  E.g. requesting a4°dONLNdS
ıZ
~*protocolp@°dONLNd[
ı
    )%[-level module to authenticate a user.  The code resource should start the operation that itYP°dONLNd∑Z    (Z_is responsible for.  You can allocate memory and other needed resources.  You can also call ARA°dONLNdZ%Ó* Service Routines asynchronously.
°dONLNd8+H9î(5HkSecurityEnd 8F8/

år°dONLNdEIZU    +\kSecurityEnd is sent when the operations that the resource performs are being finished.  Youˇˇ˘V°dONLNd¢[Zg
%*.should do your cleanup at this time.  You can Üú°dONLNd–[
%g
3)Ànot‹°dONLNd”[
4g    )0 make any calls to ARA Service Routines after or°dONLNdmZy™(vZduring this action.
°dONLNdHçÃ(âHkSecurityDataAvailable åFå/
°dONLNd/ùZ©
R+9kSecurityDataAvailable is not being used in this release.
    (Ú$*Copyright © 1992, 1993 Apple Computer Inc.(Ú616ˇ    dˇˇˇˇˇd

d,    Helvetica
    .ˇ+$,ARA Add-on Security Interface(,Version 1.0°dONLNd6HDù(@HkSecurityAbort CFC/,Palatino
˜Ñ°dONLNdTZ`    +]kSecurityAbort is sent when the operation of your code resource is being aborted.  You should
ç°dONLNdmfZr    *^stop any further processing by your code resource (including in your completion routine.  E.g.zÚ°dONLNdÃxZÑ    *`through the use of a flag).  Your code resource should terminate any outstanding asynch calls toˇˇ¯‡°dONLNd
-äZñ    *^routines other than ARA Service Routines.  Outstanding ARA Service Routines will be aborted by°dONLNd
åúZ®r*ARA.
°dONLNd
ëÆHº≈(∏HkSecurityTickleAction ªFª/
VL°dONLNd
ßÃZÿ    +YkSecurityTickleAction is sent to your code resource periodically.  You can also request a2&°dONLNd
fiZÍ    *RkSecurityTickleAction explicitly by calling the ARATicleMe routine.  When you calln¿°dONLNdTZ¸    *[ARATickleMe you pass an additional parameter which is sent to your "MySecurityProcEntry" as
&°dONLNd∞
Z
    *athe LongParam.  This additional parameter can be used as a state indicator.  E.g. an asynchronous=P°dONLNd
Z
     *`call has finished, so from your completion routine you call ARATickleMe with the state indicatorˇˇ˝ °dONLNds
&Z
2    *_"DidMyAsynchCall" (this can be a value in an enum).  In processing of kSecurityTickleAction youhÇ°dONLNd”
8Z
D    *\check the LongParam to see if it matches "DidMyAsynchCall".  If it matches you know you have n°dONLNd0
JZ
V    *_finished your asynchronous operation and are ready to transition to the next state.  You should
°dONLNdê
\Z
h    *Zalso do an ARATickleMe when you need to perform main thread time operations (e.g. allocatel˝°dONLNdÎ
nZ
z    *\memory) .  When kSecurityTickleAction is being sent periodically by ARA LongParam will be 0.|≥°dONLNdI
ÄZ
å    *VFor an example on the use of kSecurityTickleAction and ARATickleMe refer to the Sample°dONLNd†
íZ
û~*module.
    (Ú$*Copyright © 1992, 1993 Apple Computer Inc.(Ú617ˇ&dˇˇˇˇˇd

d,    Helvetica
    .ˇ+$,ARA Add-on Security Interface(,Version 1.0,Palatino°dONLNdB6R≈(N6ARA Service Routines R4R/

Δå°dONLNdgZs    +$"\ARA Service Routines are a set of functions that code resources have access to.  Using thesexÓ°dONLNdryZÖ    *Zroutines, code resources can request ARA services.  The following is a list of ARA Service°dONLNdÕãZóÉ*    Routines:,
Courier°dONLNd◊≥gøë+(ARARead°dONLNdflæg ó*ARAWrite°dONLNdË…g’µ*ARALogMessage°dONLNdˆ‘g‡µ*ARACallBackAt°dONLNd
flgÎØ*ARAAllowUser°dONLNd
Ígˆ«*ARADontAllowUser°dONLNd
"ıg

Ÿ*ARAReadSecurityData°dONLNd
6
g
Ò*ARAReadLockSecurityData°dONLNd
N
g
fl*ARAWriteSecurityData°dONLNd
c
g
"Â*ARAUnlockSecurityData°dONLNd
y
!g
-ª*ARAGetUserInfo°dONLNd
à
,g
8©*ARATickleMe°dONLNd
î
7g
Cfl*ARACompleteOperation°dONLNd
©
RZ
^
S(
[Z9The following sub-sections describe each of the routines.
°dONLNd
Â
nH
|b(
xHNote
pâ°dONLNd
Í
åZ
ò    +LAll of the routines expect a MyReference parameter.  This value is passed to7P°dONLNd7
ûZ
™    *["MySecurityProcEntry", and is a unique value representing the instance of the security code°dONLNdì
∞Z
ºÇ*    resource.
    (Ú$*Copyright © 1992, 1993 Apple Computer Inc.(Ú618ˇ
ñdˇˇˇˇˇd

d,    Helvetica
    .ˇ+$,ARA Add-on Security Interface(,Version 1.0°dONLNdRH`(\HARARead _F_/,Palatino°dONLNdpH~m*Syntax,
Courier
°dONLNdägñµ+pascal ARAErr°dONLNdäΔñ
b)_ARARead( SecurityReference°dONLNd9ä
Öñ
Õ)øMyReference,°dONLNdL
(ûˆ void°dONLNdVï
Ö°
¡)è
* DataPtr,°dONLNdg†ˆ¨
(©ˆ int°dONLNdp†
Ö¨
ª)è    DataSize,°dONLNdÄ´ˆ∑
Ä(¥ˆ SecurityCompletionProc°dONLNdò´
Ö∑
fl)èCompletionProc,°dONLNdÆ∂ˆ¬
(øˆ long°dONLNd∏∂
Ö¬
Ò)èCompletionParam );
°dONLNdÀ—Hflà(€HDescription

    Ô°dONLNd◊ÔZ˚    +^This routine is used to issue an asynchronous read call to ARA.  The read will complete eitherÁ*°dONLNd
6

Z
    *]when ARA times out, or the number of bytes requested is read.  This read is used to read dataÒ∑°dONLNd
î
Z
*[coming from the remote machine.  The protocol-level modules read from each other.  The lineä9°dONLNd
Ô

    (

-°dONLNd

%Z
1
@(
.Z4level module reads from a device on the server side.
°dONLNd%
AH
OÑ(
KH
Parameters
°dONLNd0
_Z
k
º+QMyReference is the unique identifier passed to the code resource's entry routine.
M
°dONLNdÇ
{Z
á    *_DataPtr points to a location where the data will be read to.  It must not be released while the°dONLNd‚
çZ
ô
*$asynchronous read has not completed.|≥°dONLNd
©Z
µ    *\DataSize is the maximum number of bytes to be read to DataPtr.  The maximum data size is 500°dONLNdd
ªZ
«s*bytes.fÑ°dONLNdk
◊Z
„    *^CompletionProc is a function pointer you provide to be called when the read operation has been°dONLNd 
ÈZ
ı
˛*]completed.  If a time-out occurs the CompletionProc is called with a kARATimeout result code.T∫°dONLNd(Z    *UCompletionParam is additional information you can provide which will be passed to the°dONLNd~Z#§*CompletionProc.
°dONLNdé3HAë(=HReturn Value
°dONLNdõQZ]
fl+UResult code.  Non kARANoErr result codes are usually because the call was not queued.
°dONLNdÒmH{b(wHNote
U“°dONLNdˆãZó    +aThis is an asynchronous call and can be called during interrupt time.  The DataPtr field must not°dONLNdXùZ©

*)be released until the call has completed.
    (Ú$*Copyright © 1992, 1993 Apple Computer Inc.(Ú619ˇ
Bdˇˇˇˇˇd

d,    Helvetica
    .ˇ+$,ARA Add-on Security Interface(,Version 1.0,Palatino°dONLNd6HDw(@HSee Also
°dONLNd    TZ`â+ARAWrite
    (Ú$*Copyright © 1992, 1993 Apple Computer Inc.(Ú620ˇ
@dˇˇˇˇˇd

d,    Helvetica
    .ˇ+$,ARA Add-on Security Interface(,Version 1.0°dONLNdHHV(RHARAWrite UFU/,Palatino°dONLNd    fHtm*Syntax,
Courier
°dONLNdÄgåµ+pascal ARAErr°dONLNdÄΔå
h)_ARAWrite( SecurityReference°dONLNd<Ä
ùå
Â)◊MyReference,°dONLNdOãˆó
(îˆ  void°dONLNd[ã
ùó
Ÿ)ß
* DataPtr,°dONLNdlñˆ¢
(üˆ  int°dONLNdwñ
ù¢
”)ß    DataSize,°dONLNdá°ˆ≠
Ü(™ˆ  SecurityCompletionProc°dONLNd†°
ù≠
˜)ßCompletionProc,°dONLNd∂¨ˆ∏
(µˆ  long°dONLNd¬¨
ù∏    )ßCompletionParam );
°dONLNd’«H’à(—HDescription
¡Ã°dONLNd·ÂZÒ
Æ+KThis routine can be used to write data to the remote machine.  For protocolà°dONLNd
,Â
ØÒ
(Ó
Ø-level authentication
f°dONLNd
B˜Z

f(
Z>the data is transferred over a reliable link, whereas for line;<°dONLNd
Ę
g
    (

g&-level authentication the data is justrç°dONLNd
ß
    Z
    (
Z`transferred over the connection without any packetization.  Protocol-level modules write to each°dONLNd
Z
'
ë*Iother.  Line-level modules write to a security device on the server side.
°dONLNdR
7H
EÑ(
AH
Parameters
°dONLNd]
UZ
a
º+PMyReference is the unique reference passed to the code resource's entry routine.°dONLNdÆ
qZ
}
0*3DataPtr is a pointer to the data to be written out.°dONLNd‚
çZ
ô
⁄*VDataSize is the number of bytes to be written.  A maximum of 500 bytes can be written.(°dONLNd9
©Z
µ    *`CompletionProc is a pointer to a completion routine which will be called when the write has been°dONLNdö
ªZ
«ã*
completed.T∫°dONLNd•
◊Z
„    *UCompletionParam is additional information you can provide which will be passed to the°dONLNd˚
ÈZ
ı§*CompletionProc.
°dONLNdHë(HReturn Value
°dONLNd#Z/
±+NResult code.  Errors are usually caused when the write call can not be queued.
°dONLNdg?HMb(IHNote
’5°dONLNdl]Zi    +`This is an asynchronous call and can be called at interrupt time.  The DataPtr field must not be°dONLNdÕoZ{
*+released until the call has been completed.
°dONLNd˘ãHôw(ïHSee Also
°dONLNd©ZµÜ+ARARead
    (Ú$*Copyright © 1992, 1993 Apple Computer Inc.(Ú621ˇfidˇˇˇˇˇd

d,    Helvetica
    .ˇ+$,ARA Add-on Security Interface(,Version 1.0°dONLNdHHV™(RHARALogMessage UFU/,Palatino°dONLNdfHtm*Syntax,
Courier
°dONLNdÄgå
•+5extern pascal ARAErr ARALogMessage( SecurityReference°dONLNdKÄ
∂å
˛(â
∂MyReference,°dONLNd`ã
%ó
U(î
%    char°dONLNdlã
∂ó
Ú)ë
* Message,°dONLNdñ
%¢!(ü
%*    SecurityCompletionProc CompletionProc,°dONLNd≤°
%≠
U*    long°dONLNdæ°
∂≠")ëCompletionParam );
°dONLNd—«H’à(—HDescription
°dONLNd›ÂZÒ
è+FYou can use this routine to have a message logged to the ARA log file.
°dONLNd
$

H
Ñ(
H
Parameters
°dONLNd
/
Z
+
g+@Message is a Pascal string which will be stored in the log file.
°dONLNd
p
;H
Ië(
EHReturn Value
°dONLNd
}
YZ
eè+Result code.
°dONLNd
ä
uH
Éb(
HNote
°dONLNd
è
ìZ
ü
á+DThis is an asynchronous call that can be made during interrupt time.
    (Ú$*Copyright © 1992, 1993 Apple Computer Inc.(Ú622ˇ
6dˇˇˇˇˇd

d,    Helvetica
    .ˇ+$,ARA Add-on Security Interface(,Version 1.0°dONLNdRH`°(\HARACallBackAt _F_/,Palatino°dONLNdpH~m*Syntax,
Courier
°dONLNdägñ
{+.pascal ARAErr ARACallBackAt( SecurityReference°dONLNdEä
ùñ
Â(ì
ùMyReference,°dONLNdX
(ûˆ  °dONLNd[ï
°
,) char°dONLNdeï
ù°
Î)è* DialString,°dONLNdy†ˆ¨
ò(©ˆ     SecurityCompletionProc°dONLNdï†
ù¨
˜)ßCompletionProc,°dONLNd´´ˆ∑
,(¥ˆ         long°dONLNdπ´
ù∑    )ßCompletionParam );
°dONLNdÃΔH‘à(–HDescription
Ñ°dONLNdÿ‰Z    +^This routine can be used to change the phone number which ARA will call back at.  In order for
i–°dONLNd
7ˆZ
    *^this routine to work the call-back must be enabled for the given user.  The call-back won't be°dONLNd
ñ
Z
”*executed until all other add`°dONLNd
≤
‘

å)z(-on security modules have been executed.ÑÓ°dONLNd
€
$Z
0    (
-Z]The new number is only used for the current session, and won't change the permanent call-back°dONLNd9
6Z
B*number.
°dONLNdA
RH
`Ñ(
\H
Parameters
®|°dONLNdL
pZ
|    +`DialString is a Pascal string which contains the phone number to dial.  It must be a valid phone°dONLNd≠
ÇZ
é*number.°dONLNdµ
ûZ
™    *WCompletionProc is a routine pointer which will be called when the phone number has been°dONLNd
∞Z
º
4*0assigned (not when the call-back has been made).
Ô§°dONLNd>
ÃZ
ÿ    *XCompletionParam can contain additional information you can supply to be passed on to the°dONLNdó
fiZ
ͧ*CompletionProc.
°dONLNdß
˙Hë(HReturn Value
°dONLNd¥Z$è+Result code.
°dONLNd¡4HBb(>HNote
°dONLNdΔRZ^
q+@This is an asynchronous call that can be made at interrupt time._ΰdONLNdnZz    *WThe CompletionProc is called when the DialString has been stored by ARA.  Since anotherÎY°dONLNd_ÄZå    *`security module could override this DialString by another call to this routine, the user may not°dONLNd¿íZû‘*get called at this DialString.°dONLNdflÆZ∫
≈*RThis routine can only be used by a server-side protocol-level code resource (SRPR)
    (Ú$*Copyright © 1992, 1993 Apple Computer Inc.(Ú623ˇ⁄dˇˇˇˇˇd

d,    Helvetica
    .ˇ+$,ARA Add-on Security Interface(,Version 1.0°dONLNdRH`ú(\HARAAllowUser _F_/,Palatino°dONLNdpH~m*Syntax,
Courier
°dONLNdâgï
{+.pascal ARAErr  ARAAllowUser( SecurityReference°dONLNdDâ
ùï
Â(í
ùMyReference,°dONLNdXî
†
ò(ù
 SecurityCompletionProc°dONLNdpî
ù†
˜)èCompletionProc,°dONLNdáü
´
,(®
 long°dONLNdëü
ù´    )èCompletionParam );
°dONLNd§∫H»à(ƒHDescription
â`°dONLNd∞ÿZ‰    +_This routine is used to let ARA know that the user has been authenticated.  It also informs ARA◊|°dONLNd
ÍZˆ    *^that the operation has been completed.  ARA will then send the code resource's entry routine a°dONLNd
o¸Z

w*@kSecurityEnd action, after which ARA proceeds to the next state.
°dONLNd
∞
H
&Ñ(
"H
Parameters
°dONLNd
ª
6Z
B
˚+\CompletionProc is a completion routine which will be called when ARA has accepted this call.üí°dONLNd
RZ
^    *UCompletionParam is additional information you can supply that will be provided to the°dONLNdn
dZ
p§*CompletionProc.
°dONLNd~
ÄH
éë(
äHReturn Value
°dONLNdã
ûZ
™è+Result code.
°dONLNdò
∫H
»b(
ƒHNote
°dONLNdù
ÿZ
‰
á+DThis is an asynchronous call that can be made during interrupt time.
°dONLNd‚
ÙHw(
˛HSee Also
°dONLNdÎZ
*+&ARADontAllowUser, ARACompleteOperation
    (Ú$*Copyright © 1992, 1993 Apple Computer Inc.(Ú624ˇ<dˇˇˇˇˇd

d,    Helvetica
    .ˇ+$,ARA Add-on Security Interface(,Version 1.0°dONLNdRH`∑(\HARADontAllowUser _F_/,Palatino°dONLNdpH~m*Syntax,
Courier
°dONLNdâgï
ì+2pascal ARAErr  ARADontAllowUser( SecurityReference°dONLNdLâ
∂ï
˛(í
∂MyReference,°dONLNdaî
%†
C(ù
% char°dONLNdkî
∂†
Ú)ë
* Message,°dONLNd~ü
%´
Ø(®
% SecurityCompletionProc°dONLNdñü
∂´)ëCompletionProc,°dONLNdÆ™
%∂
C(≥
% long°dONLNd∏™
∂∂")ëCompletionParam );
°dONLNdÀ≈H”à(œHDescription
VX°dONLNd◊„ZÔ    +`You can call this routine when the user has failed authentication.  ARA will send a kSecurityEnd°dONLNd
8ıZ


È*Zaction to the code resources entry routine, after which ARA will tear down the connection.
°dONLNd
ì
H
Ñ(
H
Parameters

9˘°dONLNd
û
/Z
;    +^Message is an optional Pascal string which states why the user failed authentication.  You can°dONLNd
˝
AZ
MŒ*pass a NIL for the pointer.°dONLNd
]Z
i
÷*TCompletionProc is your routine which will be called when ARA has accepted this call.°dONLNdn
yZ
Ö
‰*TCompletionParam is a parameter you can supply which is passed to the CompletionProc.
°dONLNd√
ïH
£ë(
üHReturn Value
°dONLNd–
≥Z
øè+Result code.
°dONLNd›
œH
›b(
ŸHNote
°dONLNd‚
ÌZ
˘
á+DThis is an asynchronous call that can be made during interrupt time.
°dONLNd'    Hw(HSee Also
°dONLNd0'Z3
+"ARAAllowUser, ARACompleteOperation
    (Ú$*Copyright © 1992, 1993 Apple Computer Inc.(Ú625ˇ    dˇˇˇˇˇd

d,    Helvetica
    .ˇ+$,ARA Add-on Security Interface(,Version 1.0°dONLNdRH`»(\HARAReadSecurityData _F_/,Palatino°dONLNdpH~m*Syntax,
Courier
°dONLNdägñ
•+5pascal ARAErr  ARAReadSecurityData( SecurityReference°dONLNdQä
∂ñ
˛(ì
∂MyReference,°dONLNdfï
%°
U(û
%    void°dONLNdrï
∂°
Ú)ë
* DataPtr,°dONLNd܆
%¨
O(©
%    int°dONLNdí†
∂¨
Ï)ë    DataSize,°dONLNd£´
∑
í(¥
SecurityCompletionProc°dONLNdª´
∂∑)®CompletionProc,°dONLNd”∂
%¬
U(ø
%    long°dONLNdfl∂
∂¬")ëCompletionParam );
°dONLNdÚ—Hflà(€HDescription
∏!°dONLNd˛ÔZ˚    +`This routine is used to read data for the given type of security module which is associated with
<c°dONLNd
_

Z
    *`either a user or a connection.  On the server this data is associated with a given user.  On theZk°dONLNd
¿
Z
    *`client side this data is associated with the connection.  The maximum amount of data that can be°dONLNd!
%Z
1≠*stored is 150 bytes.
°dONLNd6
AH
OÑ(
KH
Parameters
°dONLNdA
_Z
k
U+;DataPtr points to where the security data is to be read to.°dONLNd}
{Z
á
Δ*RDataSize is the maximum amount of data to read.  It should not be larger than 150.°dONLNd–
óZ
£
È*ZCompletionProc is a pointer to a routine which will be called when the data has been read.°dONLNd+
≥Z
ø*\CompletionParam is additional information you can provide to be passed to the CompletionProc
°dONLNdà
œH
ݑ(
ŸHReturn Value
°dONLNdï
ÌZ
˘è+Result code.
°dONLNd¢    Hb(HNote
æÿ°dONLNdß'Z3    +^On the ARA server this data is associated with a given user and stored in the users and groups°dONLNd9ZE
¶*Ndatabase.  On the client side this data is associated with a given connection.
°dONLNdUUHcw(_HSee Also
°dONLNd^sZ
∑+DARAReadLockSecurityData, ARAWriteSecurityData, ARAUnlockSecurityData
    (Ú$*Copyright © 1992, 1993 Apple Computer Inc.(Ú626ˇ
Êdˇˇˇˇˇd

d,    Helvetica
    .ˇ+$,ARA Add-on Security Interface(,Version 1.0°dONLNd<HJ‰(FHARAReadLockSecurityData IFI/,Palatino°dONLNdZHhm*Syntax,
Courier
°dONLNdtgÄ
Ω+9pascal ARAErr  ARAReadLockSecurityData( SecurityReference°dONLNdYt
΀(}
ŒMyReference,°dONLNdn
%ã
+(à
%
 °dONLNdp
>ã
\) void°dONLNdy
∂ã
Ú)x
* DataPtr,°dONLNdçä
%ñ
U(ì
%     int°dONLNdôä
∂ñ
Ï)ë    DataSize,°dONLNd™ï
°
í(û
SecurityCompletionProc°dONLNd¬ï
∂°)®CompletionProc,°dONLNd⁄†
%¨
7(©
%   °dONLNdfi†
>¨
\) long°dONLNdÁ†
∂¨")xCompletionParam );
°dONLNd˙ªH…à(≈HDescription
Dz°dONLNd
ŸZ    +YThis routine is used to read and lock data for the given type of security module which is∏‡°dONLNd
`ÎZ˜    *bassociated with either a user or a connection.  On the server this data is associated with a given
!∏°dONLNd
√˝Z
        *]user.  On the client side this data is associated with the connection.  The maximum amount of
ey°dONLNd!
Z
    *Zdata that can be read or written is 150 bytes.  You should use the ARAReadLockSecurityDataS∞°dONLNd|
!Z
-    *ainstead of ARAReadSecurityData if you plan to modify or write the security data.  This is crucial°dONLNdfi
3Z
?
Á*Xon the server, because you can have multiple threads attempting to modify the same data.
°dONLNd7
OH
]Ñ(
YH
Parameters
°dONLNdB
mZ
y
U+;DataPtr points to where the security data is to be read to.°dONLNd~
âZ
ï
Δ*RDataSize is the maximum amount of data to read.  It should not be larger than 150.°dONLNd—
•Z
±
È*ZCompletionProc is a pointer to a routine which will be called when the data has been read.°dONLNd,
¡Z
Õ*\CompletionParam is additional information you can provide to be passed to the CompletionProc
°dONLNdâ
›H
Îë(
ÁHReturn Value
°dONLNdñ
˚Zè+Result code.
°dONLNd£H%b(!HNote
æÿ°dONLNd®5ZA    +^On the ARA server this data is associated with a given user and stored in the users and groups°dONLNdGZS
¶*Ndatabase.  On the client side this data is associated with a given connection.°dONLNdVcZo
√*NYou must call ARAUnlockSecurityData to remove the lock from the security data.
°dONLNd•Hçw(âHSee Also
°dONLNdÆùZ©
°+@ARAReadSecurityData, ARAWriteSecurityData, ARAUnlockSecurityData
    (Ú$*Copyright © 1992, 1993 Apple Computer Inc.(Ú627ˇ    bdˇˇˇˇˇd

d,    Helvetica
    .ˇ+$,ARA Add-on Security Interface(,Version 1.0°dONLNdRH`…(\HARAWriteSecurityData _F_/,Palatino°dONLNdpH~m*Syntax,
Courier
°dONLNdâgï
•+5pascal ARAErr ARAWriteSecurityData( SecurityReference°dONLNdRâ
∂ï
˛(í
∂MyReference,°dONLNdgî
%†
U(ù
%    void°dONLNdsî
∂†
Ú)ë
* DataPtr,°dONLNdÜü
%´
O(®
%    int°dONLNdíü
∂´
Ï)ë    DataSize,°dONLNd£™
∂
§(≥
   SecurityCompletionProc°dONLNdΩ™
∂∂)®CompletionProc,°dONLNd’µ
%¡
U(æ
%    long°dONLNd·µ
∂¡")ëCompletionParam );
°dONLNdÙ–Hfià(⁄HDescription
∏B°dONLNd
ÓZ˙    +_This routine can be used by the security modules (mostly configuration code resources) to storeA∂°dONLNd
`
Z
    *cconfiguration data which is associated with either a user or a connection.  On the server this data°dONLNd
ƒ
Z

∫*Tis associated with a user.  On the client this data is associated with a connection.
°dONLNd
.H
<Ñ(
8H
Parameters
°dONLNd$
LZ
X
+(DataPtr points to the data to be stored.°dONLNdM
hZ
t
≥*RDataSize is the number of bytes to store.  It should be less than or equal to 150.·Í°dONLNd†
ÑZ
ê    *^CompletionProc is a pointer to a completion routine that will be called when the data has been°dONLNdˇ
ñZ
¢|*written.°dONLNd
≤Z
æ*]CompletionParam is additional information you can provide to be passed to the CompletionProc.
°dONLNdf
ŒH
‹ë(
ÿHReturn Value
°dONLNds
ÏZ
¯è+Result code.
°dONLNdÄHb(HNote
æÿ°dONLNdÖ&Z2    +^On the ARA server this data is associated with a given user and stored in the users and groups°dONLNd‰8ZD
¶*Ndatabase.  On the client side this data is associated with a given connection.°dONLNd3TZ`
«*RA line-level authentication code resource (CLLN) can not modify the security data.
°dONLNdÜpH~w(zHSee Also
°dONLNdèéZö
π+EARAReadSecurityData, ARAReadLockSecurityData, , ARAUnlockSecurityData
    (Ú$*Copyright © 1992, 1993 Apple Computer Inc.(Ú628ˇbdˇˇˇˇˇd

d,    Helvetica
    .ˇ+$,ARA Add-on Security Interface(,Version 1.0°dONLNdHHV”(RHARAUnlockSecurityData UFU/,Palatino°dONLNdfHtm*Syntax,
Courier
°dONLNdgã
´+6pascal ARAErr ARAUnlockSecurityData( SecurityReference°dONLNdT
∂ã
˛(à
∂MyReference,°dONLNdhä
ñ
§(ì
   SecurityCompletionProc°dONLNdÇä
∂ñ)®CompletionProc,°dONLNdöï
%°
a(û
%
      long°dONLNd®ï
∂°")ëCompletionParam );
°dONLNdª∞Hæà(∫HDescription
”ç°dONLNd«ŒZ⁄    +IThis routine removes a lock from security data that has been locked using°dONLNd
‡ZÏÿ*ARAReadLockSecurityData.
°dONLNd
*¸H

Ñ(
H
Parameters
·Í°dONLNd
5
Z
&    +^CompletionProc is a pointer to a completion routine that will be called when the data has been°dONLNd
î
,Z
8|*written.°dONLNd
ù
HZ
T*]CompletionParam is additional information you can provide to be passed to the CompletionProc.
°dONLNd
˚
dH
rë(
nHReturn Value
°dONLNd
ÇZ
éè+Result code.
°dONLNd
ûH
¨b(
®HNote
°dONLNd
ºZ
»
Á+RYou must call ARAUnlockSecurityData after you have called ARAReadLockSecurityData.
°dONLNdm
ÿH
Êw(
‚HSee Also
°dONLNdv
ˆZ
≠+BARAReadSecurityData, ARAReadLockSecurityData, ARAWriteSecurityData
    (Ú$*Copyright © 1992, 1993 Apple Computer Inc.(Ú629ˇ|dˇˇˇˇˇd

d,    Helvetica
    .ˇ+$,ARA Add-on Security Interface(,Version 1.0°dONLNdRH`¶(\HARAGetUserInfo _F_/,Palatino°dONLNdpH~m*Syntax,
Courier
°dONLNdâgïµ+pascal ARAErr°dONLNd$âΔï
å)_!ARAGetUserInfo( SecurityReference°dONLNdFâ
ùï
Â)◊MyReference,°dONLNd[î
%†
=(ù
%void°dONLNdcî
ù†
Ÿ)x
* DataPtr,°dONLNdvü
%´
7(®
%int°dONLNd~ü
ù´
”)x    DataSize,°dONLNdê™
%∂
©(≥
%SecurityCompletionProc°dONLNdß™
∂∂)ëCompletionProc,°dONLNdøµ
%¡
=(æ
%long°dONLNd«µ
ù¡    )xCompletionParam );
°dONLNd⁄–Hfià(⁄HDescription
åJ°dONLNdÊÓZ˙    +bThis routine is used to get information about the user.  Currently it returns the user's name.  On°dONLNd
I
Z

™*Pthe server this is the information for the user dialing in, or being configured.
°dONLNd
ö
H
*Ñ(
&H
Parameters
°dONLNd
•
:Z
F
N+8DataPtr points to where this information will be stored.°dONLNd
fi
VZ
b
F*3DataSize is the maximum number of bytes to be read.°dONLNd
rZ
~*^CompletionProc is a completion routine that will be called when the information has been read.°dONLNdq
éZ
ö*]CompletionParam is additional information you can provide to be passed to the CompletionProc.
°dONLNdœ
™H
∏ë(
¥HReturn Value
°dONLNd‹
»Z
‘è+Result code.
    (Ú$*Copyright © 1992, 1993 Apple Computer Inc.(Ú630ˇÚdˇˇˇˇˇd

d,    Helvetica
    .ˇ+$,ARA Add-on Security Interface(,Version 1.0°dONLNdRH`î(\HARATickleMe _F_/,Palatino°dONLNdpH~m*Syntax,
Courier
°dONLNdägñµ+pascal ARAErr°dONLNd!äΔñ
z)_ARATickleMe( SecurityReference°dONLNdAä
ùñ
Â)◊MyReference,°dONLNdUï
°
,(û
 long°dONLNd_ï
ù°
Ò)èTickleParam );
°dONLNdn∞Hæà(∫HDescription

%0°dONLNdzŒZ⁄    +^This routine causes ARA to send a  kSecurityTickleAction to the code resource's entry routine.=$°dONLNd⁄‡ZÏ    *YFor example, you can use this routine from completion routines to have your entry routine°dONLNd
4ÚZ˛Ä*invoked.
°dONLNd
=
H
Ñ(
H
Parameters
^‚°dONLNd
H
,Z
8    +_TickleParam is additional information you can provide which will be passed to the entry routineºÚ°dONLNd
®
>Z
J    *]in its LongParam parameter.  When ARA calls the entry routine with a kSecurityTickleAction it°dONLNd
PZ
\
≤*Opasses a 0 for the LongParam parameter.  You can use this as a state indicator.
°dONLNdV
lH
zë(
vHReturn Value
°dONLNdc
äZ
ñè+Result code.
°dONLNdp
¶H
¥b(
∞HNote
aY°dONLNdu
ƒZ
–    +\This function can be called during interrupt time.  The kSecurityTickleAction is sent to the°dONLNd“
÷Z
‚
*)"MySecurityProcEntry" at SystemTask time.
°dONLNd¸
ÚHw(
¸HSee Also
°dONLNdZº+kSecurityTickleAction
    (Ú$*Copyright © 1992, 1993 Apple Computer Inc.(Ú631ˇ,dˇˇˇˇˇd

d,    Helvetica
    .ˇ+$,ARA Add-on Security Interface(,Version 1.0°dONLNdHHV—(RHARACompleteOperation UFU/,Palatino°dONLNdfHtm*Syntax,
Courier
°dONLNdgãµ+pascal ARAErr°dONLNd*Δã
∂)_(ARACompleteOperation( SecurityReference °dONLNdS
Œã"(à
ŒMyReference );
°dONLNdböH®à(§HDescription

Vç°dONLNdn∏Zƒ    +]You call this routine when you need to end the operation the code resource is performing.  Itvñ°dONLNdà Z÷    *]causes ARA to send a kSecurityEnd action.  For example the configuration code resource should°dONLNd
*‹ZË
œ*Wcall this routine when the user has finished inputting information into its dialog box.
°dONLNd
ǯH
Ñ(
H
Parameters
°dONLNd
ç
Z
"
º+PMyReference is the unique reference passed to the code resource's entry routine.
°dONLNd
fi
2H
@ë(
<HReturn Value
°dONLNd
Î
PZ
\è+Result code.
°dONLNd
¯
lH
zw(
vHSee Also
°dONLNd

äZ
ñ
+(kSecurityBegin, and kSecurityEnd actions
    (Ú$*Copyright © 1992, 1993 Apple Computer Inc.(Ú632ˇfdˇˇˇˇˇd

d,    Helvetica
    .ˇ+$,ARA Add-on Security Interface(,Version 1.0,Palatino°dONLNdX6h
M(d6+Appendix A:  Security Interface Header File h4h/,
Courier
°dONLNd,m6y*P//234567890123456789012345678901234567890123456789012345678901234567890123456789°dONLNd}x6Ñ*M//===========================================================================°dONLNdÀÉ6èB*//°dONLNdŒÉNèl)File:°dONLNd‘É~è)0SecurityInterface.h°dONLNdËé6öB(ó6//°dONLNdÎô6•B*//°dONLNdÓôN•
Ê)DThis file is the header file which a third party security vendor can°dONLNd
3§6∞B(≠6//°dONLNd
6§N∞
Ï)Euse to create an add-on security module.  The add-on security modules°dONLNd
|Ø6ªB(∏6//°dONLNd
ØNª
Ê)Dcan be used to integrate a security device with Apple Remote Access.°dONLNd
ƒ∫6ΔB(√6//°dONLNd
«≈6—B*//°dONLNd
 ≈N—
L)*Copyright © 1992, 1993 Apple Computer Inc.°dONLNd
ı–6‹B(Ÿ6//°dONLNd
¯–N‹¿)All rights reserved°dONLNd€6ÁB(‰6//°dONLNdÊ6ÚB*//°dONLNdÊNÚ“)Author:  Farzad Sarabi°dONLNd)Ò6˝B(˙6//°dONLNd,¸6
B*//°dONLNd/¸N
Ã)Modification history:°dONLNdE
6
B(
6//°dONLNdH
6
B*//°dONLNdK
N
Ñ)    9/29/1993°dONLNdU
ò
º)JFarzad°dONLNd]
fi

˛)F0Removed declarations for some routines that were°dONLNdé
6
)B(
&6//°dONLNdó
fi
)
)®    obsolete.°dONLNd°
(6
4B(
16//°dONLNd§
(N
4Ñ)    2/15/1993°dONLNdÆ
(ò
4º)JFarzad°dONLNd∂
(fi
4
Ï)F-The A5 world and a working environment is now°dONLNd‰
36
?B(
<6//°dONLNdÌ
3fi
?
¯)®/setup for the security modules.  As a result of°dONLNd
>6
JB(
G6//°dONLNd&
>fi
J
Ê)®,this some of the routines in this module are°dONLNdS
I6
UB(
R6//°dONLNd\
Ifi
U)®3obsolete.  Among these are ARAGet/SetMyPrivateData,°dONLNdê
T6
`B(
]6//°dONLNdô
Tfi
`
>)®ARAGetMyResFile.°dONLNd™
_6
kB(
h6//°dONLNd≠
_N
kÑ)    10/6/1992°dONLNd∑
_ò
kº)JFarzad°dONLNdø
_fi
k
)FCreated°dONLNd«
j6
v(
s6M//===========================================================================°dONLNd
ã6
ó“*!#ifndef SECURITY_INTERFACE°dONLNd0
ñ6
¢fi*#define SECURITY_INTERFACE 1°dONLNdM
¨6
∏ú*#ifndef __FILES__°dONLNd_
∑6
√f*#include°dONLNdh
∑~
√¥)H    <Files.h>°dONLNdr
¬6
ŒZ(
À6#endif°dONLNdy
„6
Ô¿*!#ifndef SECURITY_PUBLIC°dONLNdë
Ó6
˙f*#include°dONLNdö
Ó~
˙Í)H"SecurityPublic.h"°dONLNd≠
˘6Z(6#endif°dONLNd¥6&*!M//===========================================================================°dONLNd%61B*//°dONLNd%N1r)Macros°dONLNd06<(96M//===========================================================================°dONLNdZF6R
&*(#define kSecurityInterfaceVersion 0x0100°dONLNdÉF
>R
‡(O
>// 0x0100 will be release 1°dONLNdüg6s¢(p6#ifdef __cplusplus°dONLNd≤r6~r*
extern "C"°dONLNdΩr~~Ñ)H
{°dONLNd¬rfi~
»)`'// in case we are linking into C++ code°dONLNdÍ}6âZ(Ü6#endif°dONLNdÒ©6µ*,M//===========================================================================°dONLNd?¥6¿B*//°dONLNdB¥N¿l)Types°dONLNdHø6À(»6M//===========================================================================°dONLNdñ’6·
h*3// actions are defined in the SecurityPublic.h file
    (Ú$*Copyright © 1992, 1993 Apple Computer Inc.(Ú633ˇNdˇˇˇˇˇd

d,    Helvetica
    .ˇ+$,ARA Add-on Security Interface(,Version 1.0,
Courier
°dONLNd66B
&(?6(// ARAErr is defined in SecurityPublic.h°dONLNd)A6M
h*3// SecurityEntryProc is defined in SecurityPublic.h°dONLNd]L6X
Ü*8// SecurityCompletionProc is defined in SecurityPublic.h°dONLNdñb6n*M//===========================================================================°dONLNd‰m6yB*//°dONLNdÁmNyf)Data°dONLNdÏx6Ñ(Å6M//===========================================================================°dONLNd
:ô6•*!M//===========================================================================°dONLNd
à§6∞B*//°dONLNd
ã§N∞Ñ)    Functions°dONLNd
ïØ6ª(∏6M//===========================================================================°dONLNd
„≈6—
¯*K// the following are functions you can call to have AppleTalk Remote Access°dONLNd/–6‹Ã*// perform these services°dONLNdI¸6
Æ*,extern pascal ARAErr°dONLNd^¸Δ

b)êARARead( SecurityReference°dONLNdz¸
Ö

Õ)øMyReference,°dONLNdè
ˆ

(
ˆ void°dONLNdô

Ö

¡)è
* DataPtr,°dONLNd¨
ˆ

(
ˆ int°dONLNdµ

Ö

ª)è    DataSize,°dONLNd«
ˆ
)
Ä(
&ˆ SecurityCompletionProc°dONLNdfl

Ö
)
fl)èCompletionProc,°dONLNd˜
(ˆ
4
(
1ˆ long°dONLNd

(
Ö
4
Ò)èCompletionParam );°dONLNd
36
?(
<6M//===========================================================================°dONLNdb
>6
JB*//°dONLNde
>N
Jñ)Description:°dONLNdr
>Æ
J
‘)`1this routine is used to post an asynchronous read°dONLNd§
I6
UB(
R6//°dONLNd´
IÆ
U
⁄)x2operation for data coming from the remote machine.°dONLNdfi
T6
`B(
]6//°dONLNdÂ
TÆ
`)x9This routine can be used by line-level and protocol-level°dONLNd
_6
kB(
h6//°dONLNd&
_Æ
k
Œ)x0authentication modules.  It is not available for°dONLNdX
j6
vB(
s6//°dONLNd_
jÆ
v
2)xconfiguration modules.°dONLNdv
u6
ÅB(
~6//°dONLNdy
Ä6
åB*//°dONLNd|
ÄN
åê)Parameters:°dONLNdâ
ÄÆ
å)`MyReference°dONLNdñ
Ä

å
¬)`this module's unique reference°dONLNdµ
ã6
óB(
î6//°dONLNdº
ãÆ
óÿ)xDataPtr°dONLNdΔ
ã

ó
™)`where to put the read data°dONLNd·
ñ6
¢B(
ü6//°dONLNdË
ñÆ
¢fi)xDataSize°dONLNdÚ
ñ

¢
‡)`#the maximum number of bytes to read°dONLNd
°6
≠B(
™6//°dONLNd
°Æ
≠
)xCompletionProc°dONLNd,
°

≠
Ê)`$this routine will be called when the°dONLNdQ
¨6
∏B(
µ6//°dONLNd\
¨

∏
§)ÿread request has finished°dONLNdv
∑6
√B(
¿6//°dONLNd}
∑Æ
√
)xCompletionParam°dONLNdç
∑

√
Ú)`&this is information you can provide to°dONLNd¥
¬6
ŒB(
À6//°dONLNdø
¬

Œ
Œ)ÿ be passed to the completion proc°dONLNd‡
Õ6
ŸB(
÷6//°dONLNd„
ÿ6
‰B*//°dONLNdÊ
ÿN
‰ú)Return Value:°dONLNdÙ
ÿÆ
‰“)`ARAErr°dONLNd˝
ÿ

‰
¯)`'result code, nonzero indicates an error°dONLNd%
„6
ÔB(
Ï6//°dONLNd(
Ó6
˙B*//°dONLNd+
ÓN
˙¢)Creation Date:°dONLNd:
ÓÆ
˙‰)`    10/6/1992°dONLNdD
˘6B(6//°dONLNdG6B*//°dONLNdJN¢)Modifications:°dONLNdY6B(6//°dONLNd\6&*M//===========================================================================°dONLNd™F6RÆ*,extern pascal ARAErr°dONLNdøFΔR
h)êARAWrite( SecurityReference°dONLNd›F
ùR
Â)◊MyReference,°dONLNdÚQˆ]
(Zˆ  void°dONLNd˛Q
ù]
Ÿ)ß
* DataPtr,°dONLNd\ˆh
(eˆ  int°dONLNd\
ùh
”)ß    DataSize,°dONLNd.gˆs
Ü(pˆ  SecurityCompletionProc°dONLNdGg
ùs
˜)ßCompletionProc,°dONLNd_rˆ~
({ˆ  long°dONLNdkr
ù~    )ßCompletionParam );°dONLNd~}6â(Ü6M//===========================================================================°dONLNdÃà6îB*//°dONLNdœàNîñ)Description:°dONLNd‹àÆî
Ê)`4this routine is used to asynchronously write data to°dONLNdì6üB(ú6//°dONLNdìÆü
Ï)x5the remote machine.  It can be used by line-level and°dONLNdNû6™B(ß6//°dONLNdUûÆ™
í)x&protocol-level authentication modules.°dONLNd|©6µB(≤6//°dONLNd¥6¿B*//°dONLNdÇ¥N¿ê)Parameters:°dONLNdè¥Æ¿)`MyReference°dONLNdú¥
¿
å)`your unique reference°dONLNd≤ø6ÀB(»6//°dONLNdπøÆÀÿ)xDataPtr°dONLNd√ø
À
™)`the data to be written out°dONLNdfi 6÷B(”6//°dONLNd Æ÷fi)xDataSize°dONLNdÔ 
÷
∞)`the amount of data to write°dONLNd    ’6·B(fi6//°dONLNd    ’Æ·
)xCompletionProc°dONLNd    !’
·
Ê)`$this routine is called when the data
    (Ú$*Copyright © 1992, 1993 Apple Computer Inc.(Ú634ˇdˇˇˇˇˇd

d,    Helvetica
    .ˇ+$,ARA Add-on Security Interface(,Version 1.0,
Courier
°dONLNd66BB(?6//°dONLNd6
B
Ü)ÿhas been written out°dONLNd A6MB(J6//°dONLNd'AÆM
)xCompletionParam°dONLNd7A
M)`)this is extra information you can provide°dONLNdaL6XB(U6//°dONLNdlL
X
⁄)ÿ"to be passed to the CompletionProc°dONLNdèW6cB(`6//°dONLNdíb6nB*//°dONLNdïbNnú)Return Value:°dONLNd£bÆn“)`ARAErr°dONLNd¨b
n
¯)`'result code, nonzero indicates an error°dONLNd‘m6yB(v6//°dONLNd◊x6ÑB*//°dONLNd⁄xNÑ¢)Creation Date:°dONLNdÈxÆщ)`    10/6/1992°dONLNdÛÉ6èB(å6//°dONLNdˆé6öB*//°dONLNd˘éNö¢)Modifications:°dONLNd
ô6•B(¢6//°dONLNd
§6∞*M//===========================================================================°dONLNd
Y–6‹
t*,5extern pascal ARAErr ARALogMessage( SecurityReference°dONLNd
ê–
ù‹
Â(Ÿ
ùMyReference,°dONLNd
•€ˆÁ
&(‰ˆ    char°dONLNd
≤€
ùÁ
Ÿ)ß
* Message,°dONLNd
≈ʈÚ
í(Ôˆ    SecurityCompletionProc°dONLNd
‡Ê
ùÚ
˜)ßCompletionProc,°dONLNd
¯Òˆ˝
&(˙ˆ    long°dONLNdÒ
ù˝    )ßCompletionParam );°dONLNd¸6
(
6M//===========================================================================°dONLNdf
6
B*//°dONLNdi
N
ñ)Description:°dONLNdv
Æ

Ú)`6you can use this routine to put a message in AppleTalk°dONLNd≠
6
B(
6//°dONLNd¥
Æ

D)xremote accesses log file.°dONLNdŒ
6
)B(
&6//°dONLNd—
(6
4B*//°dONLNd‘
(N
4ê)Parameters:°dONLNd·
(Æ
4)`MyReference°dONLNdÓ
(

4
å)`your unique reference°dONLNd
36
?B(
<6//°dONLNd
3Æ
?ÿ)xMessage°dONLNd
3

?
¯)`'a Pascal string which will be logged to°dONLNd=
>6
JB(
G6//°dONLNdH
>

J
h)ÿin the log file°dONLNdX
I6
UB(
R6//°dONLNd_
IÆ
U
)xCompletionProc°dONLNdn
I

U
Ê)`$this routine will be called when the°dONLNdì
T6
`B(
]6//°dONLNdû
T

`
»)ÿlog message has been completed.°dONLNdæ
_6
kB(
h6//°dONLNd≈
_Æ
k
)xCompletionParam°dONLNd’
_

k
˛)`(additional information you can supply to°dONLNd˛
j6
vB(
s6//°dONLNd    
j

v
‡)ÿ#be passed on to the completion proc°dONLNd-
u6
ÅB(
~6//°dONLNd0
Ä6
åB*//°dONLNd3
ÄN
åú)Return Value:°dONLNdA
ÄÆ
å“)`ARAErr°dONLNdJ
Ä

å
¯)`'result code, nonzero indicates an error°dONLNdr
ã6
óB(
î6//°dONLNdu
ñ6
¢B*//°dONLNdx
ñN
¢¢)Creation Date:°dONLNdá
ñÆ
¢‰)`    10/6/1992°dONLNdë
°6
≠B(
™6//°dONLNdî
¨6
∏B*//°dONLNdó
¨N
∏¢)Modifications:°dONLNd¶
∑6
√B(
¿6//°dONLNd©
¬6
Œ*M//===========================================================================°dONLNd˜
Ó6
˙
t*,5extern pascal ARAErr ARACallBackAt( SecurityReference°dONLNd.
Ó
ù
˙
Â(
˜
ùMyReference,°dONLNdC
˘ˆ
&(ˆ    char°dONLNdP
˘
ù
Î)ß* DialString,°dONLNdfˆ
í(ˆ    SecurityCompletionProc°dONLNdÅ
ù
˜)ßCompletionProc,°dONLNdôˆ
&(ˆ    long°dONLNd¶
ù    )ßCompletionParam );°dONLNdπ6&(#6M//===========================================================================°dONLNd%61B*//°dONLNd
%N1ñ)Description:°dONLNd%Æ1
‘)`1this routine can be used during authentication to°dONLNdI06<B(96//°dONLNdP0Æ<
»)x/cause the server to call the client back at the°dONLNdÄ;6GB(D6//°dONLNdá;ÆG
)xspecified number.°dONLNdôF6RB(O6//°dONLNdúQ6]B*//°dONLNdüQN]ê)Parameters:°dONLNd¨QÆ])`MyReference°dONLNdπQ
]
å)`your unique reference°dONLNdœ\6hB(e6//°dONLNd÷\ÆhÍ)x
DialString°dONLNd‚\
h
⁄)`"this is a pascal string which must°dONLNdg6sB(p6//°dONLNdg
s
Ê)ÿ$contain a dial string for the number°dONLNd5r6~B({6//°dONLNd@r
~
™)ÿto call the client back at°dONLNd[}6âB(Ü6//°dONLNdb}Æâ
)xCompletionProc°dONLNdq}
â
)`*this proc will be called when the callback°dONLNdúà6îB(ë6//°dONLNdßà
î
Ä)ÿhas been completed.°dONLNdªì6üB(ú6//°dONLNd¬ìÆü
)xCompletionParam°dONLNd“ì
ü
Ú)`&additional information you can provide°dONLNd˘û6™B(ß6//°dONLNdû
™)ÿ)that will be passed to the CompletionProc°dONLNd.©6µB(≤6//°dONLNd1¥6¿B*//°dONLNd4¥N¿ú)Return Value:°dONLNdB¥Æ¿“)`ARAErr°dONLNdK¥
¿
¯)`'result code, nonzero indicates an error°dONLNdsø6ÀB(»6//°dONLNdv 6÷B*//°dONLNdy N÷¢)Creation Date:°dONLNdà Æ÷‰)`    10/6/1992°dONLNdí’6·B(fi6//
    (Ú$*Copyright © 1992, 1993 Apple Computer Inc.(Ú635ˇ dˇˇˇˇˇd

d,    Helvetica
    .ˇ+$,ARA Add-on Security Interface(,Version 1.0,
Courier
°dONLNd66BB(?6//°dONLNd6NB¢)Modifications:°dONLNdA6MB(J6//°dONLNdL6X*M//===========================================================================°dONLNdcx6Ñ
t*,5extern pascal ARAErr  ARAAllowUser( SecurityReference°dONLNdöx
ùÑ
Â(Å
ùMyReference,°dONLNd∞É
è
í(å
SecurityCompletionProc°dONLNd«É
ùè
˜)èCompletionProc,°dONLNd‡é
ö
&(ó
long°dONLNdÈé
ùö    )èCompletionParam );°dONLNd¸ô6•(¢6M//===========================================================================°dONLNd
J§6∞B*//°dONLNd
M§N∞ñ)Description:°dONLNd
Z§Æ∞
‡)`3the authentication code on the server can call this°dONLNd
éØ6ªB(∏6//°dONLNd
ïØƪ
Ï)x5routine to indicate the user has passed this module's°dONLNd
À∫6ΔB(√6//°dONLNd
“∫ÆΔ
2)xsecurity requirements.°dONLNd
È≈6—B(Œ6//°dONLNd
Ï–6‹B*//°dONLNd
Ô–N‹ê)Parameters:°dONLNd
¸–Æ‹)`MyReference°dONLNd    –
‹
å)`your unique reference°dONLNd€6ÁB(‰6//°dONLNd&€ÆÁ
)xCompletionProc°dONLNd5€
Á
Ï)`%this routine is called when AppleTalk°dONLNd[Ê6ÚB(Ô6//°dONLNdfÊ
Ú
‡)ÿ#Remote Access has finished handling°dONLNdäÒ6˝B(˙6//°dONLNdïÒ
˝
Œ)ÿ your authentication information.°dONLNd∂¸6
B(
6//°dONLNdπ
6
B*//°dONLNdº
N
ú)Return Value:°dONLNd 
Æ
“)`ARAErr°dONLNd”



¯)`'result code, nonzero indicates an error°dONLNd˚
6
B(
6//°dONLNd˛
6
)B*//°dONLNd

N
)¢)Creation Date:°dONLNd
Æ
)‰)`    10/6/1992°dONLNd
(6
4B(
16//°dONLNd
36
?B*//°dONLNd 
3N
?¢)Modifications:°dONLNd/
>6
JB(
G6//°dONLNd2
I6
U*M//===========================================================================°dONLNdÄ
u6
Å
å*,9extern pascal ARAErr  ARADontAllowUser( SecurityReference°dONLNdª
u
∂
Å
˛(
~
∂MyReference,°dONLNd“
Ä
%
å
=(
â
%char°dONLNd€
Ä
∂
å
Ú)ë
* Message,°dONLNd
ã
%
ó
©(
î
%SecurityCompletionProc°dONLNd
ã
∂
ó)ëCompletionProc,°dONLNd!
ñ
%
¢
=(
ü
%long°dONLNd*
ñ
∂
¢")ëCompletionParam );°dONLNd=
°6
≠(
™6M//===========================================================================°dONLNdã
¨6
∏B*//°dONLNdé
¨N
∏ñ)Description:°dONLNdõ
¨Æ
∏
‡)`3the server security module can call this routine to°dONLNdœ
∑6
√B(
¿6//°dONLNd÷
∑Æ
√
å)x%prevent a user from being allowed in.°dONLNd¸
¬6
ŒB(
À6//°dONLNdˇ
Õ6
ŸB*//°dONLNd
ÕN
Ÿê)Parameters:°dONLNd
ÕÆ
Ÿ)`MyReference°dONLNd
Õ

Ÿ
å)`your unique reference°dONLNd2
ÿ6
‰B(
·6//°dONLNd9
ÿÆ
‰ÿ)xMessage°dONLNdC
ÿ

‰
Ê)`$a pascal string stating why the user°dONLNdh
„6
ÔB(
Ï6//°dONLNds
„

Ô
í)ÿwas not allowed access°dONLNdä
Ó6
˙B(
˜6//°dONLNdë
ÓÆ
˙
)xCompletionProc°dONLNd†
Ó

˙
Ê)`$this routine will be called when the°dONLNd≈
˘6B(6//°dONLNd–
˘

Ï)ÿ%request for not allowing user has bee°dONLNdˆ6B(6//°dONLNd


D)ÿ    processed°dONLNd6B(6//°dONLNdÆ
)xCompletionParam°dONLNd"

Ú)`&additional information you can provide°dONLNdI6&B(#6//°dONLNdT
&
Ú)ÿ&which will be passed to the completion°dONLNd{%61B(.6//°dONLNdÜ%
1
&)ÿproc°dONLNdã06<B(96//°dONLNdé;6GB*//°dONLNdë;NGú)Return Value:°dONLNdü;ÆG“)`ARAErr°dONLNd®;
G
¯)`'result code, nonzero indicates an error°dONLNd–F6RB(O6//°dONLNd”Q6]B*//°dONLNd÷QN]¢)Creation Date:°dONLNdÂQÆ]‰)`    10/6/1992°dONLNdÔ\6hB(e6//°dONLNdÚg6sB*//°dONLNdıgNs¢)Modifications:°dONLNdr6~B({6//°dONLNd}6â*M//===========================================================================°dONLNdU¥6¿
û*7<extern pascal ARAErr  ARAReadSecurityData( SecurityReference°dONLNdí¥
∂¿
˛(Ω
∂MyReference,°dONLNd©ø
%À
O(»
%   void°dONLNdµø
∂À
Ú)ë
* DataPtr,°dONLNd  
%÷
I(”
%   int°dONLNd’ 
∂÷
Ï)ë    DataSize,°dONLNdË’
·
í(fi
SecurityCompletionProc°dONLNd’
∂·)®CompletionProc,
    (Ú$*Copyright © 1992, 1993 Apple Computer Inc.(Ú636ˇ»dˇˇˇˇˇd

d,    Helvetica
    .ˇ+$,ARA Add-on Security Interface(,Version 1.0,
Courier
°dONLNd6
%B
O(?
%   long°dONLNd6
∂B")ëCompletionParam );°dONLNdA6M(J6M//===========================================================================°dONLNdmL6XB*//°dONLNdpLNXñ)Description:°dONLNd}LÆX
¯)`7this routine can be used to read data for this security°dONLNdµW6cB(`6//°dONLNdºWÆc
Ï)x5module which is associated with either a user (on the°dONLNdÚb6nB(k6//°dONLNd˘bÆn
‡)x3server side), or a connection (on the client side).°dONLNd
-m6yB(v6//°dONLNd
4mÆy
¯)x7This routine doesn't lock the data, so use it only when°dONLNd
lx6ÑB(Å6//°dONLNd
sxÆÑ
h)xyou just plan to read the data.°dONLNd
ìÉ6èB(å6//°dONLNd
ñé6öB*//°dONLNd
ôéNöê)Parameters:°dONLNd
¶éÆö)`MyReference°dONLNd
≥é
ö
å)`your unique reference°dONLNd
…ô6•B(¢6//°dONLNd
–ôÆ•ÿ)xDataPtr°dONLNd
⁄ô
•
¬)`where the data will be read to°dONLNd
˘§6∞B(≠6//°dONLNd§Æ∞fi)xDataSize°dONLNd
§
∞
»)`maximum number of bytes to read°dONLNd*Ø6ªB(∏6//°dONLNd1Øƪ
)xCompletionProc°dONLNd@Ø
ª
Ê)`$this routine will be called when the°dONLNde∫6ΔB(√6//°dONLNdp∫
Δ
™)ÿread request has completed°dONLNdã≈6—B(Œ6//°dONLNdí≈Æ—
)xCompletionParam°dONLNd¢≈
—
Ú)`&additional information you can provide°dONLNd…–6‹B(Ÿ6//°dONLNd‘–
‹
‡)ÿ#to be passed to the completion proc°dONLNd¯€6ÁB(‰6//°dONLNd˚Ê6ÚB*//°dONLNd˛ÊNÚú)Return Value:°dONLNdÊÆÚ“)`ARAErr°dONLNdÊ
Ú
¯)`'result code, nonzero indicates an error°dONLNd=Ò6˝B(˙6//°dONLNd@¸6
B*//°dONLNdC¸N
¢)Creation Date:°dONLNdR¸Æ
‰)`    10/6/1992°dONLNd\
6
B(
6//°dONLNd_
6
B*//°dONLNdb
N
¢)Modifications:°dONLNdq
6
)B(
&6//°dONLNdt
(6
4*M//===========================================================================°dONLNd¬
T6
`
∞*,?extern pascal ARAErr ARAReadLockSecurityData( SecurityReference°dONLNd
T
∂
`
˛(
]
∂MyReference,°dONLNd
_
>
k
b(
h
>  void°dONLNd$
_
∂
k
Ú)x
* DataPtr,°dONLNd:
j
>
v
\(
s
>  int°dONLNdC
j
∂
v
Ï)x    DataSize,°dONLNdW
u
%
Å
©(
~
%SecurityCompletionProc°dONLNdn
u
∂
Å)ëCompletionProc,°dONLNdâ
Ä
>
å
b(
â
>  long°dONLNdì
Ä
∂
å")xCompletionParam );°dONLNd¶
ã6
ó(
î6M//===========================================================================°dONLNdÙ
ñ6
¢B*//°dONLNd˜
ñN
¢ñ)Description:°dONLNd
ñÆ
¢
¯)`7this routine can be used to read security data and lock°dONLNd<
°6
≠B(
™6//°dONLNdC
°Æ
≠)x9it to be modified.  If you are planning on modifying your°dONLNd}
¨6
∏B(
µ6//°dONLNdÑ
¨Æ
∏
Ï)x5data and then writing it, you must call this routine.°dONLNd∫
∑6
√B(
¿6//°dONLNd¡
∑Æ
√)x9It locks the data until the a ARAUnlockSecurityData call.°dONLNd˚
¬6
ŒB(
À6//°dONLNd˛
Õ6
ŸB*//°dONLNd

ÕN
Ÿê)Parameters:°dONLNd
ÕÆ
Ÿ)`MyReference°dONLNd
Õ

Ÿ
å)`your unique reference°dONLNd1
ÿ6
‰B(
·6//°dONLNd8
ÿÆ
‰ÿ)xDataPtr°dONLNdB
ÿ

‰
∞)`where the data will be read°dONLNd^
„6
ÔB(
Ï6//°dONLNde
„Æ
Ôfi)xDataSize°dONLNdo
„

Ô
‡)`#the maximum number of bytes to read°dONLNdì
Ó6
˙B(
˜6//°dONLNdö
ÓÆ
˙
)xCompletionProc°dONLNd©
Ó

˙
Ê)`$this routine will be called when the°dONLNdŒ
˘6B(6//°dONLNdŸ
˘

¬)ÿdata is read into your buffer.°dONLNd¯6B(6//°dONLNdˇÆ
)xCompletionParam°dONLNd
)`)additional information you can provide to°dONLNd96B(6//°dONLNdD

‡)ÿ#be passed on to the CompletionProc.°dONLNdh6&B(#6//°dONLNdk%61B*//°dONLNdn%N1ú)Return Value:°dONLNd|%Æ1“)`ARAErr°dONLNdÖ%
1
¯)`'result code, nonzero indicates an error°dONLNd≠06<B(96//°dONLNd∞;6GB*//°dONLNd≥;NG¢)Creation Date:°dONLNd¬;ÆGÍ)`
10/29/1992°dONLNdÕF6RB(O6//°dONLNd–Q6]B*//°dONLNd”QN]¢)Modifications:°dONLNd‚\6hB(e6//°dONLNdÂg6s*M//===========================================================================°dONLNd3û6™Æ*7extern pascal ARAErr°dONLNdHûΔ™
∂)ê(ARAUnlockSecurityData( SecurityReference°dONLNdqû
Œ™(ß
ŒMyReference,°dONLNdâ©
>µ
¬(≤
>SecurityCompletionProc°dONLNd†©
Œµ()êCompletionProc,°dONLNdª¥
>¿
h(Ω
>   long°dONLNd«¥
Œ¿()êCompletionParam°dONLNd◊ø6ÀB(»6);°dONLNd⁄ 6÷*M//===========================================================================°dONLNd    (’6·B*//°dONLNd    +’N·ñ)Description:°dONLNd    8’Æ·()`?if you have read the security data with ARAReadLockSecurityData
    (Ú$*Copyright © 1992, 1993 Apple Computer Inc.(Ú637ˇ∫dˇˇˇˇˇd

d,    Helvetica
    .ˇ+$,ARA Add-on Security Interface(,Version 1.0,
Courier
°dONLNd66BB(?6//°dONLNd6ÆB
)x:you must call this routine to unlock the data.  After this°dONLNdBA6MB(J6//°dONLNdIAÆM
∂)x,call others can then lock the security data.°dONLNdvL6XB(U6//°dONLNdyW6cB*//°dONLNd|WNcê)Parameters:°dONLNdâWÆc)`MyReference°dONLNdñW
c
å)`your unique reference°dONLNd¨b6nB(k6//°dONLNd≥bÆn
)xCompletionProc°dONLNd¬b
n.)`0this routine is called when the data is unlocked°dONLNdÛm6yB(v6//°dONLNd˙mÆy
)xCompletionParam°dONLNd

m
y)`+additiona information you can provide to be°dONLNd
6x6ÑB(Å6//°dONLNd
Ax
Ñ
∂)ÿpassed to the CompletionProc°dONLNd
^É6èB(å6//°dONLNd
aé6öB*//°dONLNd
déNöú)Return Value:°dONLNd
réÆö“)`ARAErr°dONLNd
{é
ö
¯)`'result code, nonzero indicates an error°dONLNd
£ô6•B(¢6//°dONLNd
¶§6∞B*//°dONLNd
©§N∞¢)Creation Date:°dONLNd
∏§Æ∞Í)`
10/29/1992°dONLNd
√Ø6ªB(∏6//°dONLNd
Δ∫6ΔB*//°dONLNd
…∫NΔ¢)Modifications:°dONLNd
ÿ≈6—B(Œ6//°dONLNd
€–6‹*M//===========================================================================°dONLNd)¸6

û*,<extern pascal ARAErr ARAWriteSecurityData( SecurityReference°dONLNdf¸
∂

˛(

∂MyReference,°dONLNd}

%

O(

%   void°dONLNdâ

∂

Ú)ë
* DataPtr,°dONLNdû

%

I(

%   int°dONLNd©

∂

Ï)ë    DataSize,°dONLNdº


)(
&
)   SecurityCompletionProc CompletionProc,°dONLNd
(
%
4
O+   long°dONLNd˚
(
ù
4    )xCompletionParam );°dONLNd
36
?(
<6M//===========================================================================°dONLNd\
>6
JB*//°dONLNd_
>N
Jñ)Description:°dONLNdl
>Æ
J
¯)`7this routine can be used by the module to write private°dONLNd§
I6
UB(
R6//°dONLNd´
IÆ
U
)x:data which is either associated with a user (on the server°dONLNdÊ
T6
`B(
]6//°dONLNdÌ
TÆ
`
∂)x,side), or a connection (on the client side).°dONLNd
_6
kB(
h6//°dONLNd
j6
vB*//°dONLNd 
jN
vê)Parameters:°dONLNd-
jÆ
v)`MyReference°dONLNd:
j

v
å)`your unique reference°dONLNdP
u6
ÅB(
~6//°dONLNdW
uÆ
Åÿ)xDataPtr°dONLNda
u

Å
™)`the data to be written out°dONLNd|
Ä6
åB(
â6//°dONLNdÉ
ÄÆ
åfi)xDataSize°dONLNdç
Ä

å
»)`the amount of data to write out°dONLNd≠
ã6
óB(
î6//°dONLNd¥
ãÆ
ó
)xCompletionProc°dONLNd√
ã

ó
Ï)`%this routine is called when AppleTalk°dONLNdÈ
ñ6
¢B(
ü6//°dONLNdÙ
ñ

¢
Ï)ÿ%Remote Access has completed the write°dONLNd
°6
≠B(
™6//°dONLNd%
°

≠
D)ÿ    operation°dONLNd/
¨6
∏B(
µ6//°dONLNd6
¨Æ
∏
)xCompletionParam°dONLNdF
¨

∏
Ú)`&additional information you can provide°dONLNdm
∑6
√B(
¿6//°dONLNdx
∑

√
Ú)ÿ&which is passed to the completion proc°dONLNdü
¬6
ŒB(
À6//°dONLNd¢
Õ6
ŸB*//°dONLNd•
ÕN
Ÿú)Return Value:°dONLNd≥
ÕÆ
Ÿ“)`ARAErr°dONLNdº
Õ

Ÿ
¯)`'result code, nonzero indicates an error°dONLNd‰
ÿ6
‰B(
·6//°dONLNdÁ
„6
ÔB*//°dONLNdÍ
„N
Ô¢)Creation Date:°dONLNd˘
„Æ
Ô‰)`    10/6/1992°dONLNd
Ó6
˙B(
˜6//°dONLNd
˘6B*//°dONLNd    
˘N¢)Modifications:°dONLNd6B(6//°dONLNd6*M//===========================================================================°dONLNdi;6GÆ*,extern pascal ARAErr°dONLNd~;ΔG
å)ê!ARAGetUserInfo( SecurityReference°dONLNd†;
ùG
Â)◊MyReference,°dONLNd∑F
%R
=(O
%void°dONLNdøF
ùR
Ÿ)x
* DataPtr,°dONLNd‘Q
%]
7(Z
%int°dONLNd‹Q
ù]
”)x    DataSize,°dONLNdÔ\
h
í(e
SecurityCompletionProc°dONLNd\
ùh
˜)èCompletionProc,°dONLNd g
%s
=(p
%long°dONLNd(g
ùs    )xCompletionParam );°dONLNd;r6~({6M//===========================================================================°dONLNdâ}6âB*//°dONLNdå}Nâñ)Description:°dONLNdô}Æâ
¯)`7this routine can be called to get information about the°dONLNd—à6îB(ë6//°dONLNdÿàÆî
¯)x7the user, such as user name etc.  It is an asynchronous°dONLNdì6üB(ú6//°dONLNdìÆüÃ)xcall.°dONLNdû6™B(ß6//°dONLNd ©6µB*//°dONLNd#©Nµê)Parameters:°dONLNd0©Æµ)`MyReference°dONLNd=©
µ
™)`your unique code reference°dONLNdX¥6¿B(Ω6//°dONLNd_¥Æ¿ÿ)xDataPtr°dONLNdi¥
¿
˛)`(pointer to where the user's name (Pascal°dONLNdíø6ÀB(»6//°dONLNdùø
À
í)ÿstring) will be stored°dONLNd¥ 6÷B(”6//°dONLNdª Æ÷fi)xDataSize°dONLNd≈ 
÷
»)`maximum number of bytes to read°dONLNdÂ’6·B(fi6//°dONLNdÏ’Æ·
)xCompletionProc°dONLNd˚’
·)`)this routine will be called when the call
    (Ú$*Copyright © 1992, 1993 Apple Computer Inc.(Ú638ˇdˇˇˇˇˇd

d,    Helvetica
    .ˇ+$,ARA Add-on Security Interface(,Version 1.0,
Courier
°dONLNd66BB(?6//°dONLNd6
B
\)ÿhas completed°dONLNdA6MB(J6//°dONLNd AÆM
)xCompletionParam°dONLNd0A
M
Ú)`&additional information to be passed to°dONLNdWL6XB(U6//°dONLNdbL
X
z)ÿthe CompletionProc°dONLNduW6cB(`6//°dONLNdxb6nB*//°dONLNd{bNnú)Return Value:°dONLNdâbÆn“)`ARAErr°dONLNdíb
n
¯)`'result code, nonzero indicates an error°dONLNd∫m6yB(v6//°dONLNdΩx6ÑB*//°dONLNd¿xNÑ¢)Creation Date:°dONLNdœxÆщ)`    10/6/1992°dONLNdŸÉ6èB(å6//°dONLNd‹é6öB*//°dONLNdfléNö¢)Modifications:°dONLNdÓô6•B(¢6//°dONLNdÒ§6∞*M//===========================================================================°dONLNd
?€6Á¢*7extern pascal long°dONLNd
R€ÆÁ
å)x%ARAGetMySessionRef( SecurityReference°dONLNd
x€
ùÁ
Ò)ÔMyReference );°dONLNd
áÊ6Ú(Ô6M//===========================================================================°dONLNd
’Ò6˝B*//°dONLNd
ÿÒN˝ñ)Description:°dONLNd
ÂÒÆ˝)`9You can call this routine to obtain the session reference°dONLNd¸6
B(
6//°dONLNd&¸Æ

¯)x7for the connection for which your code is loaded.  This°dONLNd^
6
B(
6//°dONLNde
Æ
)x9value is unique and stays the same during the connection.°dONLNdü
6
B(
6//°dONLNd¶
Æ
)x9If you have a security module which has both a line-level°dONLNd‡
6
)B(
&6//°dONLNdÁ
Æ
)
Ï)x5and a protocol-level authentication, you can use this°dONLNd
(6
4B(
16//°dONLNd$
(Æ
4
Ê)x4unique reference as a key to communicate between the°dONLNdY
36
?B(
<6//°dONLNd`
3Æ
?
)xcode resources.°dONLNdp
>6
JB(
G6//°dONLNds
I6
UB*//°dONLNdv
IN
Uê)Parameters:°dONLNdÉ
IÆ
U)`MyReference°dONLNdê
I

U
Ê)`$this is your code's unique reference°dONLNdµ
T6
`B(
]6//°dONLNd∏
_6
kB*//°dONLNdª
_N
kú)Return Value:°dONLNd…
_Æ
kΔ)`long°dONLNd–
_

k
)`*the session reference, NULL if there is an°dONLNd˚
j6
vB(
s6//°dONLNd
j

v
,)ÿerror°dONLNd
u6
ÅB(
~6//°dONLNd
Ä6
åB*//°dONLNd
ÄN
å¢)Creation Date:°dONLNd!
ÄÆ
åÍ)`
10/29/1992°dONLNd,
ã6
óB(
î6//°dONLNd/
ñ6
¢B*//°dONLNd2
ñN
¢¢)Modifications:°dONLNdA
°6
≠B(
™6//°dONLNdD
¨6
∏*M//===========================================================================°dONLNdí
„6
ÔÆ*7extern pascal ARAErr°dONLNdß
„Δ
Ô
z)êARATickleMe( SecurityReference°dONLNd«
„
ù
Ô
Â)◊MyReference,°dONLNd›
Ó

˙
,(
˜
 long°dONLNdÁ
Ó
ù
˙
Ò)èTickleParam );°dONLNdˆ
˘6(6M//===========================================================================°dONLNdD6B*//°dONLNdGNñ)Description:°dONLNdTÆ
˛)`8this routine can be used to have AppleTalk Remote Access°dONLNdç6B(6//°dONLNdîÆ
Ï)x5call your entry routine with a kSecurityTickleAction.°dONLNd 6&B(#6//°dONLNd—Æ&
Ú)x6You can also provide some additional information which°dONLNd%61B(.6//°dONLNd%Æ1
h)xis passed to the entry routine.°dONLNd/06<B(96//°dONLNd2;6GB*//°dONLNd5;NGê)Parameters:°dONLNdB;ÆG)`MyReference°dONLNdO;
G
å)`your unique reference°dONLNdeF6RB(O6//°dONLNdlFÆR)xTickleParam°dONLNdyF
R
Ú)`&additional information you can provide°dONLNd†Q6]B(Z6//°dONLNd´Q
]
‘)ÿ!which is passed to the entry proc°dONLNdÕ\6hB(e6//°dONLNd–g6sB*//°dONLNd”gNsú)Return Value:°dONLNd·gÆs“)`ARAErr°dONLNdÍg
s
¯)`'result code, nonzero indicates an error°dONLNdr6~B({6//°dONLNd}6âB*//°dONLNd}Nâ¢)Creation Date:°dONLNd'}Æâ‰)`    10/6/1992°dONLNd1à6îB(ë6//°dONLNd4ì6üB*//°dONLNd7ìNü¢)Modifications:°dONLNdFû6™B(ß6//°dONLNdI©6µ*M//===========================================================================°dONLNdó’6·
§*,=extern pascal ARAErr ARACompleteOperation( SecurityReference °dONLNd’’
∂·
(fi
∂MyReference );
    (Ú$*Copyright © 1992, 1993 Apple Computer Inc.(Ú639ˇdˇˇˇˇˇd

d,    Helvetica
    .ˇ+$,ARA Add-on Security Interface(,Version 1.0,
Courier
°dONLNd66B(?6M//===========================================================================°dONLNdNA6MB*//°dONLNdQANMñ)Description:°dONLNd^AÆM
Ï)`5this routine can be called to terminate an operation.°dONLNdîL6XB(U6//°dONLNdõLÆX
Ê)x4It causes ARA to send a kSecurityEnd action.  During°dONLNd–W6cB(`6//°dONLNd◊WÆc
Ê)x4configuration for example the code resource can call°dONLNd
b6nB(k6//°dONLNd
bÆn
»)x/this routine to indicate that configuration has°dONLNd
Cm6yB(v6//°dONLNd
JmÆyÍ)x
completed.°dONLNd
Ux6ÑB(Å6//°dONLNd
XÉ6èB*//°dONLNd
[ÉNèê)Parameters:°dONLNd
hÉÆè)`MyReference°dONLNd
uÉ
è
å)`your unique reference°dONLNd
ãé6öB(ó6//°dONLNd
éô6•B*//°dONLNd
ëôN•ú)Return Value:°dONLNd
üôÆ•“)`ARAErr°dONLNd
®ô
•
¯)`'result code, nonzero indicates an error°dONLNd
–§6∞B(≠6//°dONLNd
”Ø6ªB*//°dONLNd
÷ØNª¢)Creation Date:°dONLNd
ÂØƪ‰)`    10/6/1992°dONLNd
Ô∫6ΔB(√6//°dONLNd
Ú≈6—B*//°dONLNd
ı≈N—¢)Modifications:°dONLNd–6‹B(Ÿ6//°dONLNd€6Á*M//===========================================================================°dONLNdU
6
¢*,#ifdef __cplusplus°dONLNdh
6
<*
}°dONLNdj
6
)Z*#endif°dONLNdq
>6
Jfi*!#endif // SECURITY_INTERFACE
    (Ú$*Copyright © 1992, 1993 Apple Computer Inc.(Ú640ˇ≤dˇˇˇˇˇd

d,    Helvetica
    .ˇ+$,ARA Add-on Security Interface(,Version 1.0,Palatino°dONLNdN6^
(Z6"Appendix B:  Security Module Shell ^4^/,
Courier
°dONLNd#c6o*P//234567890123456789012345678901234567890123456789012345678901234567890123456789°dONLNdtn6z*M//===========================================================================°dONLNd¬y6ÖB*//°dONLNd≈yNÖl)File:°dONLNdÀy~Öÿ)0SecurityShell.c°dONLNd€Ñ6êB(ç6//°dONLNdfiè6õB*//°dONLNd·èNõ
Œ)@This file contains a shell for add-on security modules for Apple°dONLNd
"ö6¶B(£6//°dONLNd
%öN¶
¬)>Remote Access.  This code can be duplicated to write an add-on°dONLNd
d•6±B(Æ6//°dONLNd
g•N±Ã)security code module.°dONLNd
}∞6ºB(π6//°dONLNd
Ī6«B*//°dONLNd
ɪN«
L)*Copyright © 1992, 1993 Apple Computer Inc.°dONLNd
ÆΔ6“B(œ6//°dONLNd
±ΔN“¿)All rights reserved°dONLNd
≈—6›B(⁄6//°dONLNd
»‹6ËB*//°dONLNd
À‹NË“)Author:  Farzad Sarabi°dONLNd
‚Á6ÛB(6//°dONLNd
ÂÚ6˛B*//°dONLNd
ËÚN˛Ã)Modification history:°dONLNd
˛˝6
    B(
6//°dONLNd

6
B*//°dONLNd
N
Ñ)    5/10/1993°dONLNd
ò
º)JFarzad°dONLNd
fi
)F1A little cleanup, and added a completion routine.°dONLNdH
6
B(
6//°dONLNdQ
fi

J)®Some more comments°dONLNdd
6
*B(
'6//°dONLNdg
N
*Ñ)    10/6/1992°dONLNdq
ò
*º)JFarzad°dONLNdy
fi
*
)FCreated°dONLNdÅ
)6
5(
26M//===========================================================================°dONLNdœ
U6
af*,#include°dONLNdÿ
U~
a¸)H"SecurityInterface.h"°dONLNdÓ
v6
Ç
(
6&// #define SecurityShellVersion 0x0100°dONLNd
ó6
£*!M//===========================================================================°dONLNdc
¢6
ÆB*//°dONLNdf
¢N
ÆΔ)Example of Your Code°dONLNd{
≠6
π(
∂6M//===========================================================================°dONLNd…
√6
œ∫*// function prototypes°dONLNd‡
Œ6
⁄x*static long°dONLNdÌ
Θ
⁄
L)bDoMyStartup( SecurityReference°dONLNd
Œ
U
⁄
ù)ΩMyReference,°dONLNd 
Ÿfi
¸(
‚fi long°dONLNd)
Ÿ
U
Â
ù)wLongParam );°dONLNd6
‰6
x(
Ì6static long°dONLNdC
‰ò

R)bDoMyShutdown( SecurityReference°dONLNdd
‰
Ö

Õ)ÌMyReference,°dONLNdx
Ôfi
˚
(
¯fi  long°dONLNdÉ
Ô
n
˚
∂)êLongParam );°dONLNdê
˙6x(6static long°dONLNdù
˙ò
@)bDoMyBegin( SecurityReference°dONLNd∫
˙
U
ù)ΩMyReference,°dONLNdÕΔ(Δ   long°dONLNdŸ
U
ù)èLongParam );°dONLNdÊ6x(6static long°dONLNdÛò
4)bDoMyEnd( SecurityReference°dONLNd
>
Ü)¶MyReference,°dONLNd!Δ'‰($Δ long°dONLNd*
>'
Ü)xLongParam );°dONLNd7&62x(/6static long°dONLNdD&ò2
d)b"DoMyDataHandler( SecurityReference°dONLNdg&
n2
∂)÷MyReference,°dONLNd|1ˆ=
(:ˆ long°dONLNdÖ1
n=
∂)xLongParam );°dONLNdí<6Hx(E6static long°dONLNdü<òH
j)b#DoMyAbortHandler( SecurityReference°dONLNdƒ<
ùH
Â(E
ùMyReference,°dONLNdŸGˆS
(Pˆ  long°dONLNd‰G
ÖS
Õ)èLongParam );°dONLNdÒR6^x([6static long°dONLNd˛Rò^
p)b$DoMyTickleHandler( SecurityReference°dONLNd#R
Ö^
Õ)ÌMyReference,°dONLNd8]ˆi
 (fˆ   long°dONLNdD]
Öi
Õ)èLongParam );°dONLNdQh6tx(q6pascal void°dONLNd^hòt
j)b#MyCompletionProc( SecurityReference°dONLNdÉh
ùt
Â(q
ùMyReference,°dONLNdòsˆ
(|ˆ  int°dONLNd¢s
Ö
«)èResultCode,°dONLNd∂~ˆä
(ሠ void°dONLNd¡~
Öä
¡)è
* DataPtr,°dONLNd‘âˆï
(íˆ  int°dONLNdfiâ
Öï
ª)è    DataSize,°dONLNd
(ùˆ  long°dONLNd˚î
Ö†
Ò)èCompletionParam );°dONLNdÀ6◊
¯(‘6K// the following is a shell for your code.  It shows how your entry routine°dONLNdZ÷6‚
‡*G// should be structured.  Empty supporting routines for the actions are
    (Ú$*Copyright © 1992, 1993 Apple Computer Inc.(Ú641ˇ$dˇˇˇˇˇd

d,    Helvetica
    .ˇ+$,ARA Add-on Security Interface(,Version 1.0,
Courier
°dONLNd66B~(?6// provided.°dONLNdW6cx*!// WARNING:°dONLNdb6nB*//°dONLNdbgn
·)1?Don't change the name of this routine.  We may change it in the°dONLNd]m6yB(v6//°dONLNdamgy
ô)13future.  This is the routine ARA expects and calls.°dONLNdïÉ6èx(å6pascal long°dONLNd¢Éòè
p)b$MySecurityProcEntry( SecurityActions°dONLNd»É
ùè
«(å
ùAction,°dONLNdŸé
ö
z(ó
 SecurityReference°dONLNdÌé
ùö
Â)èMyReference,°dONLNd
ô
•
,(¢
 long°dONLNd
ô
ù•
fl)èLongParam )°dONLNd
§6∞(≠6M//===========================================================================°dONLNd
gØ6ªB*//°dONLNd
jØNªñ)Description:°dONLNd
wØƪ
¯)`7this is the entry point for the ??? security operation.°dONLNd
Ø∫6ΔB(√6//°dONLNd
∂∫ÆΔ
Ê)x4It is called by AppleTalk Remote Access to have this°dONLNd
Î≈6—B(Œ6//°dONLNd
Ú≈Æ—
Œ)x0security module perform the given operation.  It°dONLNd#–6‹B(Ÿ6//°dONLNd*–Æ‹
Œ)x0dispatches to a variety of routines based on the°dONLNd[€6ÁB(‰6//°dONLNdb€ÆÁ
)xrequested action.°dONLNdtÊ6ÚB(Ô6//°dONLNdwÒ6˝B*//°dONLNdzÒN˝ê)Parameters:°dONLNdáÒÆ˝“)`Action°dONLNdëÒ
%˝
¡)wthe action to be performed°dONLNd¨¸6
B(
6//°dONLNd≥¸Æ
)xMyReference°dONLNd¡¸
%

˜)w#this is a unique value representing°dONLNdÂ
6
B(
6//°dONLNdÒ

%

Ò)Ô"this instance of this code module.°dONLNd
6
B(
6//°dONLNd
Æ
ÿ)xDataPtr°dONLNd&

%

µ)wthe data for this action°dONLNd?
6
)B(
&6//°dONLNdF
Æ
)fi)xDataSize°dONLNdQ

%
)
Ö)wthe size of data°dONLNdb
(6
4B(
16//°dONLNde
36
?B*//°dONLNdh
3N
?ú)Return Value:°dONLNdv
3Æ
?Δ)`long°dONLNd~
3
%
?
Î)w!result code, nonzero indicates an°dONLNd†
>6
JB(
G6//°dONLNd¨
>
%
J
fl)Ôerror.  Its value is one of the°dONLNdÃ
I6
UB(
R6//°dONLNdÿ
I
%
U
ù)ÔSecurityResultCodes.°dONLNdÌ
T6
`B(
]6//°dONLNd
_6
kB*//°dONLNdÛ
_N
k¢)Creation Date:°dONLNd
j6
vB(
s6//°dONLNd
u6
ÅB*//°dONLNd
uN
Å¢)Modifications:°dONLNd
Ä6
åB(
â6//°dONLNd
ã6
ó*M//===========================================================================°dONLNdh
ñ6
¢<*
{°dONLNdk
°N
≠¥+switch ( Action )°dONLNd}
°Δ
≠Ã)x
{°dONLNdÄ
∑N
√r(
¿N  case°dONLNdá
∑~
√‰)0kSecurityStartup:°dONLNdõ
¬g
Œ
u(
Àg-return DoMyStartup( MyReference, LongParam );°dONLNd 
„N
Ôr(
ÏN  case°dONLNd—
„~
ÔÍ)0kSecurityShutdown:°dONLNdÂ
ÓN
˙Z(
˜N  °dONLNdË
Óg
˙
{).return DoMyShutdown( MyReference, LongParam );°dONLNdNr(N  case°dONLNd~ÿ)0kSecurityBegin:°dONLNd0N&Z(#N  °dONLNd3g&
i)+return DoMyBegin( MyReference, LongParam );°dONLNd`;NGr(DN  case°dONLNdg;~GÃ)0kSecurityEnd:°dONLNdvFNRZ(ON  °dONLNdyFgR
]))return DoMyEnd( MyReference, LongParam );°dONLNd§gNsr(pN  case°dONLNd´g~s
)0kSecurityDataAvailable:°dONLNd≈rg~
ç({g1return DoMyDataHandler( MyReference, LongParam );°dONLNd¯ìNür(úN  case°dONLNdˇì~üÿ)0kSecurityAbort:°dONLNdûg™
ì(ßg2return DoMyAbortHandler( MyReference, LongParam );°dONLNdEøNÀr(»N  case°dONLNdLø~À
)0kSecurityTickleAction:°dONLNdd N÷Z(”N  °dONLNdg g÷
ô)3return DoMyTickleHandler( MyReference, LongParam );
    (Ú$*Copyright © 1992, 1993 Apple Computer Inc.(Ú642ˇdˇˇˇˇˇd

d,    Helvetica
    .ˇ+$,ARA Add-on Security Interface(,Version 1.0,
Courier
°dONLNd6NBT(?N
}°dONLNdLNX
2*&return ( kSecurityUnsupportedAction );°dONLNd*W6c<(`6
}°dONLNd,é6öx*7static long°dONLNd9éòö
L)bDoMyStartup( SecurityReference°dONLNdXé
Uö
ù)ΩMyReference,°dONLNdlôfi•¸(¢fi long°dONLNduô
U•
ó)wLongParam )°dONLNdŧ6∞(≠6M//===========================================================================°dONLNdœØ6ªB*//°dONLNd“ØNªñ)Description:°dONLNdflØƪ
Ú)`6this routine handles the kSecurityStartup action.  You°dONLNd
∫6ΔB(√6//°dONLNd
∫ÆΔ
Œ)x0should allocate any memory and setup the working°dONLNd
N≈6—B(Œ6//°dONLNd
U≈Æ—
t)x!environment (e.g. A5 world) here.°dONLNd
w–6‹B(Ÿ6//°dONLNd
z€6ÁB*//°dONLNd
}€NÁê)Parameters:°dONLNd
ä€ÆÁ)`MyReference°dONLNd
ó€
Á
Ä)`My unique reference°dONLNd
´Ê6ÚB(Ô6//°dONLNd
≤ÊÆÚ‰)x    LongParam°dONLNd
ΩÊ
Ú
í)`additional information°dONLNd
‘Ò6˝B(˙6//°dONLNd
◊¸6
B*//°dONLNd
⁄¸N
ú)Return Value:°dONLNd
˸Æ
Δ)`long°dONLNd
Ô¸


Ê)`$result code, nonzero indicates error°dONLNd
6
B(
6//°dONLNd
6
B*//°dONLNd
N
¢)Creation Date:°dONLNd)
6
)B(
&6//°dONLNd,
(6
4B*//°dONLNd/
(N
4¢)Modifications:°dONLNd>
36
?B(
<6//°dONLNdA
>6
J*M//===========================================================================°dONLNdè
I6
U<*
{°dONLNdë
T6
`ÿ*#pragma unused(MyReference)°dONLNd≠
_6
kÃ*#pragma unused(LongParam)°dONLNd»
uN
Å
Ê+D// this routine is called when the module has just been loaded.  You°dONLNd
ÄN
å
Ï*E// can preallocate any memory you need.  You are not yet starting any°dONLNdU
ãN
ó
Ü*4// to do what this code resource is responsible for.°dONLNdã
°N
≠
ò*7// You can allocate and release memory in this routine.°dONLNdƒ
∑N
√Í*return ( kSecurityNoErr );°dONLNdfl
¬6
Œ<(
À6
}°dONLNd·
Ó6
˙x*,static long°dONLNdÓ
Óò
˙
R)bDoMyShutdown( SecurityReference°dONLNd
Ó
Ö
˙
Õ)ÌMyReference,°dONLNd#
˘fi
(fi  long°dONLNd.
˘
n
∞)êLongParam )°dONLNd:6(6M//===========================================================================°dONLNdà6B*//°dONLNdãNñ)Description:°dONLNdòÆ
¯)`7this routine handles the kSecurityShutdown action.  You°dONLNd–6&B(#6//°dONLNd◊Æ&
Ú)x6should release any memory allocated by the DoMyStartup°dONLNd%61B(.6//°dONLNd%Æ1fi)xroutine.°dONLNd06<B(96//°dONLNd!;6GB*//°dONLNd$;NGê)Parameters:°dONLNd1;ÆG)`MyReference°dONLNd>;
G
Ä)`My unique reference°dONLNdRF6RB(O6//°dONLNdYFÆR‰)x    LongParam°dONLNddF
R
í)`additional information°dONLNd{Q6]B(Z6//°dONLNd~\6hB*//°dONLNdÅ\Nhú)Return Value:°dONLNdè\ÆhΔ)`long°dONLNdñ\
h
Ê)`$result code, nonzero indicates error°dONLNdªg6sB(p6//°dONLNdær6~B*//°dONLNd¡rN~¢)Creation Date:°dONLNd–}6âB(Ü6//°dONLNd”à6îB*//°dONLNd÷àNî¢)Modifications:°dONLNdÂì6üB(ú6//°dONLNdËû6™*M//===========================================================================°dONLNd6©6µ<*
{°dONLNd8¥6¿ÿ*#pragma unused(MyReference)°dONLNdTø6ÀÃ*#pragma unused(LongParam)°dONLNdo’N·
Ê+D// this is the last routine that is called before your code resource
    (Ú$*Copyright © 1992, 1993 Apple Computer Inc.(Ú643ˇ⁄dˇˇˇˇˇd

d,    Helvetica
    .ˇ+$,ARA Add-on Security Interface(,Version 1.0,
Courier
°dONLNd6NB
¯(?NG// is released.  Just do any cleanup you need to perform.  ARA services°dONLNdIANM*// are no longer available.°dONLNdfWNc
ò*7// You can allocate and release memory in this routine.°dONLNdümNyÍ*return ( kSecurityNoErr );°dONLNd∫x6Ñ<(Å6
}°dONLNdº§6∞x*,static long°dONLNd…§ò∞
@)bDoMyBegin( SecurityReference°dONLNdʧ
U∞
ù)ΩMyReference,°dONLNd˘ØΔª(∏Δ   long°dONLNd
Ø
Uª
ó)èLongParam )°dONLNd
∫6Δ(√6M//===========================================================================°dONLNd
_≈6—B*//°dONLNd
b≈N—ñ)Description:°dONLNd
o≈Æ—
Ï)`5this routine handles the kSecurityBeing action.  This°dONLNd
•–6‹B(Ÿ6//°dONLNd
¨–Æ‹
Ï)x5routine should start the operations the code resource°dONLNd
‚€6ÁB(‰6//°dONLNd
È€ÆÁ
Ï)x5must do.  For example an authentication code resource°dONLNdÊ6ÚB(Ô6//°dONLNd&ÊÆÚ
û)x(should start the authentication process.°dONLNdOÒ6˝B(˙6//°dONLNdR¸6
B*//°dONLNdU¸N
ê)Parameters:°dONLNdb¸Æ
)`MyReference°dONLNdo¸


Ä)`My unique reference°dONLNdÉ
6
B(
6//°dONLNdä
Æ
‰)x    LongParam°dONLNdï



í)`additional information°dONLNd¨
6
B(
6//°dONLNdØ
6
)B*//°dONLNd≤
N
)ú)Return Value:°dONLNd¿
Æ
)Δ)`long°dONLNd«


)
Ê)`$result code, nonzero indicates error°dONLNdÏ
(6
4B(
16//°dONLNdÔ
36
?B*//°dONLNdÚ
3N
?¢)Creation Date:°dONLNd

>6
JB(
G6//°dONLNd
I6
UB*//°dONLNd
IN
U¢)Modifications:°dONLNd
T6
`B(
]6//°dONLNd
_6
k*M//===========================================================================°dONLNdg
j6
v<*
{°dONLNdi
u6
Åÿ*#pragma unused(MyReference)°dONLNdÖ
Ä6
åÃ*#pragma unused(LongParam)°dONLNd†
ñN
¢
‡+C// This routine is called to actually start the code resource to do°dONLNdÂ
°N
≠
‡*C// what it's responsible for.  E.g. an authentication code resource°dONLNd*
¨N
∏
‡*C// should start the authentication process.  A configuration module°dONLNdo
∑N
√
,*%// can start displaying a dialog etc.°dONLNdñ
ÕN
Ÿ
ò*7// You can allocate and release memory in this routine.°dONLNdœ
„N
ÔÍ*return ( kSecurityNoErr );°dONLNdÍ
Ó6
˙<(
˜6
}°dONLNdÏ6&x*,static long°dONLNd˘ò&
4)bDoMyEnd( SecurityReference°dONLNd
>&
Ü)¶MyReference,°dONLNd'%Δ1‰(.Δ long°dONLNd0%
>1
Ä)xLongParam )°dONLNd<06<(96M//===========================================================================°dONLNdä;6GB*//°dONLNdç;NGñ)Description:°dONLNdö;ÆG)`9this routine handles the kSecurityEnd action.  The action°dONLNd‘F6RB(O6//°dONLNd€FÆR
‡)x3is sent to signal the end of the operation the code°dONLNdQ6]B(Z6//°dONLNdQÆ]
P)xresource was created to do.°dONLNd2\6hB(e6//°dONLNd5g6sB*//°dONLNd8gNsê)Parameters:°dONLNdEgÆs)`MyReference°dONLNdRg
s
Ä)`My unique reference°dONLNdfr6~B({6//°dONLNdmrÆ~‰)x    LongParam°dONLNdxr
~
í)`additional information°dONLNdè}6âB(Ü6//°dONLNdíà6îB*//°dONLNdïàNîú)Return Value:°dONLNd£àÆîΔ)`long°dONLNd™à
î
Ê)`$result code, nonzero indicates error°dONLNdœì6üB(ú6//°dONLNd“û6™B*//°dONLNd’ûN™¢)Creation Date:°dONLNd‰©6µB(≤6//°dONLNdÁ¥6¿B*//°dONLNdÍ¥N¿¢)Modifications:°dONLNd˘ø6ÀB(»6//°dONLNd¸ 6÷*M//===========================================================================°dONLNdJ’6·<*
{
    (Ú$*Copyright © 1992, 1993 Apple Computer Inc.(Ú644ˇ¯dˇˇˇˇˇd

d,    Helvetica
    .ˇ+$,ARA Add-on Security Interface(,Version 1.0,
Courier
°dONLNd66Bÿ(?6#pragma unused(MyReference)°dONLNdA6MÃ*#pragma unused(LongParam)°dONLNd7WNc
Ê+D// This routine is called when the code resource is finished.  It is°dONLNd}bNn
Ê*D// called as a result of you calling ARAAllowUser, ARADontAllowUser,°dONLNd√mNy
Œ*@// ARACompleteOperation, or after ARA aborts your code resource.°dONLNd
xNÑ
Ê*D// You could for example cleanup any outstanding asynch calls to the°dONLNd
KÉNè
t*1// Mac OS.  ARA services are no longer available.°dONLNd
~ôN•
ò*7// You can allocate and release memory in this routine.°dONLNd
∑ØNªÍ*return ( kSecurityNoErr );°dONLNd
“∫6Δ<(√6
}°dONLNd
‘Ê6Úx*,static long°dONLNd
·ÊòÚ
d)b"DoMyDataHandler( SecurityReference°dONLNdÊ
nÚ
∂)÷MyReference,°dONLNdÒˆ˝
(˙ˆ long°dONLNd"Ò
n˝
∞)xLongParam )°dONLNd.¸6
(
6M//===========================================================================°dONLNd|
6
B*//°dONLNd
N
ñ)Description:°dONLNdå
Æ

¯)`7this routine handles the kSecurityDataAvailable action.°dONLNdƒ
6
B(
6//°dONLNdÀ
Æ

Ï)x5The action is sent when data has arrived for the code°dONLNd

6
)B(
&6//°dONLNd
Æ
)‰)x    resource.°dONLNd
(6
4B(
16//°dONLNd
36
?B*//°dONLNd
3N
?ê)Parameters:°dONLNd%
3Æ
?)`MyReference°dONLNd2
3

?
Ä)`My unique reference°dONLNdF
>6
JB(
G6//°dONLNdM
>Æ
J‰)x    LongParam°dONLNdX
>

J
í)`additional information°dONLNdo
I6
UB(
R6//°dONLNdr
T6
`B*//°dONLNdu
TN
`ú)Return Value:°dONLNdÉ
TÆ
`Δ)`long°dONLNdä
T

`
Ê)`$result code, nonzero indicates error°dONLNdØ
_6
kB(
h6//°dONLNd≤
j6
vB*//°dONLNdµ
jN
v¢)Creation Date:°dONLNdƒ
u6
ÅB(
~6//°dONLNd«
Ä6
åB*//°dONLNd 
ÄN
å¢)Modifications:°dONLNdŸ
ã6
óB(
î6//°dONLNd‹
ñ6
¢*M//===========================================================================°dONLNd*
°6
≠<*
{°dONLNd,
¨6
∏ÿ*#pragma unused(MyReference)°dONLNdH
∑6
√Ã*#pragma unused(LongParam)°dONLNdc
ÕN
Ÿ
¯+G// This routine is not used in this release of the ARA Add-on Security.°dONLNd¨
ÿN
‰
Ú*F// In future releases we may use this to indicate data being available°dONLNdÙ
„N
Ô
‡*C// for you.  ARA may in the future send events to a modeless dialog°dONLNd9
ÓN
˙
8*'// box using the DataAvailable message.°dONLNdbN
ò*7// You can allocate and release memory in this routine.°dONLNdõN&Í*return ( kSecurityNoErr );°dONLNd∂%61<(.6
}°dONLNd∏Q6]x*,static long°dONLNd≈Qò]
j)b#DoMyAbortHandler( SecurityReference°dONLNdÍQ
ù]
Â(Z
ùMyReference,°dONLNdˇ\ˆh
(eˆ  long°dONLNd
\
Öh
«)èLongParam )°dONLNdg6s(p6M//===========================================================================°dONLNddr6~B*//°dONLNdgrN~ñ)Description:°dONLNdtrÆ~
Ê)`4this routine handles the kSecurityAbort action.  The°dONLNd©}6âB(Ü6//°dONLNd∞}Æâ
Ú)x6abort action is sent when the code resources operation°dONLNdÁà6îB(ë6//°dONLNdÓàÆî
z)x"needs to be terminated abnormally.°dONLNdì6üB(ú6//°dONLNdû6™B*//°dONLNdûN™ê)Parameters:°dONLNd$ûÆ™)`MyReference°dONLNd1û
™
Ä)`My unique reference°dONLNdE©6µB(≤6//°dONLNdL©Æµ‰)x    LongParam°dONLNdW©
µ
í)`additional information°dONLNdn¥6¿B(Ω6//°dONLNdqø6ÀB*//°dONLNdtøNÀú)Return Value:°dONLNdÇøÆÀΔ)`long°dONLNdâø
À
Ê)`$result code, nonzero indicates error°dONLNdÆ 6÷B(”6//°dONLNd±’6·B*//°dONLNd¥’N·¢)Creation Date:
    (Ú$*Copyright © 1992, 1993 Apple Computer Inc.(Ú645ˇ‹dˇˇˇˇˇd

d,    Helvetica
    .ˇ+$,ARA Add-on Security Interface(,Version 1.0,
Courier
°dONLNd66BB(?6//°dONLNdA6MB*//°dONLNdANM¢)Modifications:°dONLNdL6XB(U6//°dONLNdW6c*M//===========================================================================°dONLNdfb6n<*
{°dONLNdhm6y
‘*E// you can remove the unused pragma for any of the parameters you use°dONLNdÆx6Ñÿ*#pragma unused(MyReference)°dONLNd É6èÃ*#pragma unused(LongParam)°dONLNdÂôN•
⁄+B// This routine is called when the code resource is being aborted.°dONLNd
)§N∞
Ï*E// You should not make any more calls to ARA services, and you should°dONLNd
pØNª
‡*C// start your abort process.  You will receive the End and Shutdown°dONLNd
µ∫NΔ
* // actions a little while later.°dONLNd
◊–N‹
ò*7// You can allocate and release memory in this routine.°dONLNdÊNÚÍ*return ( kSecurityNoErr );°dONLNd+Ò6˝<(˙6
}°dONLNd-
6
)x*,static long°dONLNd:
ò
)
p)b$DoMyTickleHandler( SecurityReference°dONLNd_

Ö
)
Õ)ÌMyReference,°dONLNdt
(ˆ
4
 (
1ˆ   long°dONLNdÄ
(
Ö
4
«)èLongParam )°dONLNdå
36
?(
<6M//===========================================================================°dONLNd⁄
>6
JB*//°dONLNd›
>N
Jñ)Description:°dONLNdÍ
>Æ
J
Ï)`5this routine handles the kSecurityTickle action.  ARA°dONLNd 
I6
UB(
R6//°dONLNd'
IÆ
U
‡)x3sends this action periodically.  The action is also°dONLNd[
T6
`B(
]6//°dONLNdb
TÆ
`
¯)x7generated as a result of a call to ARATickleMe routine.°dONLNdö
_6
kB(
h6//°dONLNd¢
j6
vB*//°dONLNd•
u6
ÅB*//°dONLNd®
uN
Åê)Parameters:°dONLNdµ
uÆ
Å)`MyReference°dONLNd¬
u

Å
Ä)`My unique reference°dONLNd÷
Ä6
åB(
â6//°dONLNd›
ÄÆ
å‰)x    LongParam°dONLNdË
Ä

å
Ê)`$When ARA calls this value will be 0,°dONLNd
ã6
óB(
î6//°dONLNd
ã

ó
‡)ÿ#otherwise it is the value passed to°dONLNd<
ñ6
¢B(
ü6//°dONLNdG
ñ

¢
û)ÿthe ARATickleMe routine.°dONLNd`
°6
≠B(
™6//°dONLNdc
¨6
∏B*//°dONLNdf
¨N
∏ú)Return Value:°dONLNdt
¨Æ
∏Δ)`long°dONLNd{
¨

∏
Ê)`$result code, nonzero indicates error°dONLNd†
∑6
√B(
¿6//°dONLNd£
¬6
ŒB*//°dONLNd¶
¬N
Œ¢)Creation Date:°dONLNdµ
Õ6
ŸB(
÷6//°dONLNd∏
ÿ6
‰B*//°dONLNdª
ÿN
‰¢)Modifications:°dONLNd 
„6
ÔB(
Ï6//°dONLNdÕ
Ó6
˙*M//===========================================================================°dONLNd
˘6<*
{°dONLNd6
‘*E// you can remove the unused pragma for any of the parameters you use°dONLNdc6ÿ*#pragma unused(MyReference)°dONLNd6&Ã*#pragma unused(LongParam)°dONLNdö0N<
Ï+E// ARA calls this routine periodically.  You can also initiate a call°dONLNd·;NG
»*?// to this routine by calling ARATickleMe.  When ARA calls this°dONLNd"FNR
Ú*F// routine the LongParam value will be 0 (zero).  When it is called as°dONLNdjQN]
Ú*F// a result of a call to ARATickleMe the LongParam will have the value°dONLNd≤\Nh¸*// you passed to ARATickleMe.°dONLNd—rN~
ò*7// You can allocate and release memory in this routine.°dONLNd
àNîÍ*return ( kSecurityNoErr );°dONLNd%ì6ü<(ú6
}°dONLNd'ø6Àx*,pascal void°dONLNd4øòÀ
j)b#MyCompletionProc( SecurityReference°dONLNdYø
ùÀ
Â(»
ùMyReference,°dONLNdn ˆ÷
(”ˆ  int°dONLNdx 
Ö÷
«)èResultCode,°dONLNdå’ˆ·
(fiˆ  void°dONLNdó’
Ö·
¡)è
* DataPtr,
    (Ú$*Copyright © 1992, 1993 Apple Computer Inc.(Ú646ˇdˇˇˇˇˇd

d,    Helvetica
    .ˇ+$,ARA Add-on Security Interface(,Version 1.0,
Courier
°dONLNd6ˆB
(?ˆ  int°dONLNd
6
ÖB
ª)è    DataSize,°dONLNdAˆM
(Jˆ  long°dONLNd'A
ÖM
Î)èCompletionParam )°dONLNd9L6X(U6M//===========================================================================°dONLNdáW6cB*//°dONLNdäWNcñ)Description:°dONLNdóWÆc
¯)`7this is an example of your a completion routine you can°dONLNdœb6nB(k6//°dONLNd÷bÆn
Ú)x6use for calls to asynch ARA services.  You can use one°dONLNd
m6yB(v6//°dONLNd
mÆy
˛)x8completion proc and distinguish the reason it was called°dONLNd
Mx6ÑB(Å6//°dONLNd
TxÆÑ
∞)x+by the value passed in the CompletionParam.°dONLNd
ÄÉ6èB(å6//°dONLNd
àé6öB*//°dONLNd
ãô6•B*//°dONLNd
éôN•ê)Parameters:°dONLNd
õôÆ•)`MyReference°dONLNd
®ô
•
å)`your unique reference°dONLNd
æ§6∞B(≠6//°dONLNd
≈§Æ∞Í)x
ResultCode°dONLNd
—§
∞
Ú)`&result of the asynch ARA call you made°dONLNd
¯Ø6ªB(∏6//°dONLNd
ˇØƪÿ)xDataPtr°dONLNd    Ø
ª
Ï)`%pointer to the data passed to the ARA°dONLNd/∫6ΔB(√6//°dONLNd:∫
Δ
&)ÿproc°dONLNd?≈6—B(Œ6//°dONLNdF≈Æ—fi)xDataSize°dONLNdP≈
—
ò)`actual size of the data°dONLNdh–6‹B(Ÿ6//°dONLNdo–Æ‹
)xCompletionParam°dONLNd–
‹
‡)`#additional information you provided°dONLNd§€6ÁB(‰6//°dONLNdØ€
Á
ò)ÿto the ARA service proc°dONLNd«Ê6ÚB(Ô6//°dONLNd Ò6˝B*//°dONLNdÕÒN˝ú)Return Value:°dONLNd€ÒÆ˝Δ)`none°dONLNd‡¸6
B(
6//°dONLNd„
6
B*//°dONLNdÊ
N
¢)Creation Date:°dONLNdı
6
B(
6//°dONLNd¯
6
)B*//°dONLNd˚
N
)¢)Modifications:°dONLNd

(6
4B(
16//°dONLNd
36
?*M//===========================================================================°dONLNd[
>6
J<*
{°dONLNd]
I6
U
‘*E// you can remove the unused pragma for any of the parameters you use°dONLNd£
T6
`ÿ*#pragma unused(MyReference)°dONLNdø
_6
k“*#pragma unused(ResultCode)°dONLNd⁄
j6
v¿*#pragma unused(DataPtr)°dONLNdÚ
u6
ÅΔ*#pragma unused(DataSize)°dONLNd
Ä6
å*#pragma unused(CompletionParam)°dONLNd,
ñN
¢ê+// WARNING:°dONLNd9
°N
≠Z*//°dONLNd>
°ò
≠
Ë)J8Do not attempt to allocate or release any memory in this°dONLNdx
¨N
∏Z(
µN//°dONLNd}
¨ò
∏
‹)J6routine.  Also don't call any Mac Toolbaox/OS routines°dONLNd∂
∑N
√Z(
¿N//°dONLNdª
∑ò
√
Ó)J9that allocate or release memory.  If you need to do this,°dONLNdˆ
¬N
ŒZ(
ÀN//°dONLNd˚
¬ò
Œ
‚)J7you should call ARATickleMe with a state indicator, and°dONLNd4
ÕN
ŸZ(
÷N//°dONLNd9
Õò
Ÿ
ö)J+allow your DoMyTickle routine to handle it.°dONLNdf
„N
Ôx(
ÏNreturn;°dONLNdn
Ó6
˙<(
˜6
}
    (Ú$*Copyright © 1992, 1993 Apple Computer Inc.(Ú647ˇÄdˇˇˇˇˇd

d,    Helvetica
    .ˇ+$,ARA Add-on Security Interface(,Version 1.0,Palatino°dONLNdN6^Í(Z6Appendix C:  Miscellaneous ^4^/°dONLNdiHwƒ+Runtime Environment vFv/
}fi°dONLNd/áZì    +\ARA builds an A5 world for a code resource, so the module can have its own global data.  ARA
Ω›°dONLNdåôZ•    *^sets the A5 world automatically, prior to calling any routines (entry, completion) in the code°dONLNdδZ∑Ç*    resource.
cÓ°dONLNdı«Z”    *\The module inherits stacks from other executing tasks, and should refrain from recursion and°dONLNd
RŸZÂ∂*large stack variables.fû°dONLNd
iıZ

    *bThe resource file from which the code resources are loaded will be on the top of the resource file°dONLNd
Ã
Z
    *Zstack, when ARA executes code resources.  The security module's resource file is opened as°dONLNd'
Z
%m*readX°dONLNd+
n
%
î)A-only, and you should not attempt to modify or add any resources.°dONLNdm
5Z
A
ñ(
>ZHYou must initialize any Toolbox manager's you are using (e.g. InitGraf).
°dONLNd∂
GH
U
(
QH#Building  an Add-on Security Module 
TF
T/
e—°dONLNd⁄
eZ
q    +[You need MPW 3.2 or later and MPW C to build a security module.  The ARA Security Interface°dONLNd6
wZ
É
b*?disk contains the files you need to build a security interface.’¸°dONLNdv
ìZ
ü    *_The EmptyShell is a good starting point for putting together a code resource.  You can also use=⁄°dONLNd÷
•Z
±    *`the sample module as the starting point for your module.  This code can be used in your security°dONLNd7
∑Z
√
Ä*Bmodules, but you must keep Apple's copyrights in the source files.Ø…°dONLNdz
”Z
fl    *`After you have designed your security module (e.g. line-level vs. protocol-level and its working

Ω°dONLNd€
ÂZ
Ò    *`behavior), take the "SecurityShell.c" and code the routines that handle the actions.  The Sample°dONLNd<
˜Z
€*RModule shows how a protocol-level module that provides a second password is coded.°dONLNdèZ
u*@You must also define the proper 'sinf' resource for your module.úπ°dONLNd–/Z;    *^After you have compiled the module you must link it with "SecurityInterface.o".  You must also
M°dONLNd/AZM    *`link in "Runtime.o" (included with MPW).  SecurityInterface.o must be the first file in the link°dONLNdêSZ_
Ò*Lcommand.  The link command should also have "-m SECURITYINTERFACEENTRYPROC".°dONLNd›oZ{
›*SFor an example of how a security module is build Review the enclosed Sample Module.
    (Ú$*Copyright © 1992, 1993 Apple Computer Inc.(Ú648ˇjdˇˇˇˇˇd

d,    Helvetica
    .ˇ+$,ARA Add-on Security Interface(,Version 1.0°dONLNd<HJÊ(FHARA Security Interface Disk IFI/,Palatino
y°dONLNdZZf    +`The enclosed developer disk contains the interface files and sample modules you can use to build°dONLNd}lZx
°*Kan ARA security module.  This sections describes the contents of this disk.ˇˇ˛x°dONLNd…àZî    *fThe "Empty Shell" folder contains a file you can use to build a code resource file.  It contains place°dONLNd
0öZ¶
,*/holder routines for processing the ARA actions.
{Æ°dONLNd
`∂Z¬    *[The "Sample Protocol Module" folder contains the complete source for a security module that‚Y°dONLNd
º»Z‘    *[provides a second password.  Using this module, you can assign each user a second password.y °dONLNd⁄ZÊß*This is a protocolö~°dONLNd+⁄ßÊ)MO-level module.  You can use this code as a starting point for building your own°dONLNd{ÏZ¯~(ıZmodule.…Ó°dONLNdÉ
Z
    *X"Security Interfaces" folder contains the various header files for interfacing with ARA.∏ˆ°dONLNd›
Z
&    *a"SecurityInterface.h", and "SecurityPublic.h" contain all the declarations that your module needs
t°dONLNd?
,Z
8    *`for accessing ARA Service Routines.  "SecurityResInfo.h" contains the flags that are used in the°dONLNd†
>Z
J
–*X'sinf' resource.  "SecurityTypes.r" has the resource declarations for a security module.
'°dONLNd˘
ZZ
f    *d"SecurityLibraries" contains "SecurityInterface.o" that must be linked as the first file for each of°dONLNd^
lZ
xµ*your code resources.
    (Ú$*Copyright © 1992, 1993 Apple Computer Inc.(Ú649ˇ